Gz-Db.psd1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
#
# Module manifest for module 'Fmg-Sql'
#
# Generated by: mhern
#
# Generated on: 5/13/2017
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'Gz-Db.psm1'

# Version number of this module.
ModuleVersion = '0.1.0'

# Supported PSEditions
CompatiblePSEditions = @('Desktop', 'Core')

# ID used to uniquely identify this module
GUID = '5961e800-31fd-4d2d-8568-b92d506372b9'

# Author of this module
Author = 'Nerdy Mishka, Michael Herndon'

# Company or vendor of this module
CompanyName = 'Nerdy Mishka'

# Copyright statement for this module
Copyright = '(c) 2017-2019 Nerdy Mishka, Michael Herndon. All rights reserved.'

# Description of the functionality provided by this module
Description = '
# Gz-Db Module
 
Database agnostic Powershell functions over ADO.NET.
 
The primary functions are Invoke-GzDbCommand, Read-GzDbData, and Write-GzDbData. If
a connection or connectionString is not provided to the functions, the functions
will attempt to use the default connection set by Set-GzDbConnectionString.
 
Any function that has a `-Do` parameter, can be passed a script block that will
have the `$_` context variable set with either the connection or command object.
 
Sqlite is bundled with module. To switch the default provider use:
 
```powershell
Set-GzDbProviderFactoryDefault "Sqlite"
```
 
## Examples
 
 
- Set-GzDbConnectionString - sets the default or a named connection string.
- New-GzDbConnection - creates a new connection
- Write-GzDbData - inserts or updates data in the database.
- Read-GzDbData - reads data from the database.
- Invoke-GzDbCommand - executes a statement such as create database or grants.
 
```powershell
Set-GzDbConnectionString "Server=localhost;Database=test;Integrate Security=true" -Name "Default"
 
# uses the default connection string set above
$data = Read-GzDbData "SELECT name FROM [users]"
Write-Host $data
 
# control the connection
$connection = New-GzDbConnection -ConnectionString $cs
$connection.Open()
 
$emails = $connection | Read-GzDbData "SELECT email FROM [users]"
$connection | Write-GzDbData "INSERT [name] INTO [user_roles] ([name], [role]) VALUES (@name, 1)" -Parameters @{name = "test"}
 
$connection.Dispose()
 
# opens and closes the connection
# autocreates a `$Connection` variable
# returns any output.
$data = New-GzDbConnection -Do {
   return $Connection | Read-GzDbData "SELECT email FROM [users]"
}
 
```
 
## Gz Prefix
 
The Gz prefix exists to clobbering.
 
Add-GzDbAlias will set aliases that map to GzDb functions .e.g. Invoke-DbCommand
will be mapped to Invoke-GzDbCommand.
'


# Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '5.1'

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
RequiredAssemblies = @('bin\System.Data.SQLite.dll')

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @(
    'Add-GzDbAlias',
    'Add-GzDbProviderFactory',
    'Get-GzDbOption',
    'Set-GzDbOption',
    'Set-GzDbConnectionString',
    'Get-GzDbConnectionString',
    'New-GzDbProviderFactory',
    'Set-GzDbProviderFactory',
    'Get-GzDbProviderFactory',
    'Get-GzDbParameterPrefix',
    'Set-GzDbParameterPrefix',
    'New-GzDbConnection',
    'New-GzDbCommand',
    'Read-GzDbData',
    'Write-GzDbData',
    'Invoke-GzDbCommand',
    'Remove-GzDbAlias'
)

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @(
    
)

# Variables to export from this module
VariablesToExport = ''

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        Tags = @(
            'SQL', 
            'ADO.NET', 
            'ado', 
            'Db', 
            'Query', 
            'Database', 
            'SqlClient', 
            'Gainz', 
            "Gz", 
            "Gainz-SqlDb",
            "Windows",
            "Mac",
            "Linux"
        )

        # A URL to the license for this module.
        LicenseUri = 'https://www.apache.org/licenses/LICENSE-2.0'

        # A URL to the main website for this project.
        ProjectUri = 'https://gitlab.com/nerdymishka/gainz/tree/master/powershell/Gz-Db'

        # A URL to an icon representing this module.
        IconUri = 'https://nerdymishka.com/wp-content/themes/bad-mishka/images/logo.png'

        ReleaseNotes = '
- 0.1.0 -- Early Release.
'


    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}