-
Notifications
You must be signed in to change notification settings - Fork 71
/
adosql.ahk
163 lines (137 loc) · 7.11 KB
/
adosql.ahk
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
/*
###############################################################################################################
###### ADOSQL v5.04L - By [VxE] ######
###############################################################################################################
Wraps the utility of ADODB to connect to a database, submit a query, and read the resulting recordset.
Returns the result as a new object (or array of objects, if the query has multiple statements).
To instead have this function return a string, include a delimiter option in the connection string.
For AHK-L (v1.1 or later).
Freely available @ http://auto-hotkey.com/boards/viewtopic.php?p=365#p365
IMPORTANT! Before you can use this library, you must have access to a database AND know the connection
string to connect to your database.
Varieties of databases will have different connection string formats, and different drivers (providers).
Use the mighty internet to discover the connection string format and driver for your type of database.
Example connection string for SQLServer (2005) listening on port 3456 and with a static IP:
DRIVER={SQL SERVER};SERVER=192.168.0.12,3456;DATABASE=mydb;UID=admin;PWD=12345;APP=AHK
Copyright © 2011-2013 VxE. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, in whole or in part, are
permitted provided that the following condition is met:
1. Redistributions must retain the above copyright notice, this list of conditions and the following disclaimer.
THIS SOFTWARE IS PROVIDED BY VxE "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL VxE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
*/
Global ADOSQL_LastError, ADOSQL_LastQuery ; These super-globals are for debugging your SQL queries.
ADOSQL( Connection_String, Query_Statement ) {
; Uses an ADODB object to connect to a database, submit a query and read the resulting recordset.
; By default, this function returns an object. If the query generates exactly one result set, the object is
; a 2-dimensional array containing that result (the first row contains the column names). Otherwise, the
; returned object is an array of all the results. To instead have this function return a string, append either
; ";RowDelim=`n" or ";ColDelim=`t" to the connection string (substitute your preferences for "`n" and "`t").
; If there is more than one table in the output string, they are separated by 3 consecutive row-delimiters.
; ErrorLevel is set to "Error" if ADODB is not available, or the COM error code if a COM error is encountered.
; Otherwise ErrorLevel is set to zero.
coer := "", txtout := 0, rd := "`n", cd := "CSV", str := Connection_String ; 'str' is shorter.
; Examine the connection string for output formatting options.
If ( 9 < oTbl := 9 + InStr( ";" str, ";RowDelim=" ) )
{
rd := SubStr( str, oTbl, 0 - oTbl + oRow := InStr( str ";", ";", 0, oTbl ) )
str := SubStr( str, 1, oTbl - 11 ) SubStr( str, oRow )
txtout := 1
}
If ( 9 < oTbl := 9 + InStr( ";" str, ";ColDelim=" ) )
{
cd := SubStr( str, oTbl, 0 - oTbl + oRow := InStr( str ";", ";", 0, oTbl ) )
str := SubStr( str, 1, oTbl - 11 ) SubStr( str, oRow )
txtout := 1
}
ComObjError( 0 ) ; We'll manage COM errors manually.
; Create a connection object. > http://www.w3schools.com/ado/ado_ref_connection.asp
; If something goes wrong here, return blank and set the error message.
If !( oCon := ComObjCreate( "ADODB.Connection" ) )
Return "", ComObjError( 1 ), ErrorLevel := "Error"
, ADOSQL_LastError := "Fatal Error: ADODB is not available."
oCon.ConnectionTimeout := 9 ; Allow 9 seconds to connect to the server.
oCon.CursorLocation := 3 ; Use a client-side cursor server.
oCon.CommandTimeout := 1800 ; A generous 30 minute timeout on the actual SQL statement.
oCon.Open( str ) ; open the connection.
; Execute the query statement and get the recordset. > http://www.w3schools.com/ado/ado_ref_recordset.asp
If !( coer := A_LastError )
oRec := oCon.execute( ADOSQL_LastQuery := Query_Statement )
If !( coer := A_LastError ) ; The query executed OK, so examine the recordsets.
{
o3DA := [] ; This is a 3-dimensional array.
While IsObject( oRec )
If !oRec.State ; Recordset.State is zero if the recordset is closed, so we skip it.
oRec := oRec.NextRecordset()
Else ; A row-returning operation returns an open recordset
{
oFld := oRec.Fields
o3DA.Insert( oTbl := [] )
oTbl.Insert( oRow := [] )
Loop % cols := oFld.Count ; Put the column names in the first row.
oRow[ A_Index ] := oFld.Item( A_Index - 1 ).Name
While !oRec.EOF ; While the record pointer is not at the end of the recordset...
{
oTbl.Insert( oRow := [] )
oRow.SetCapacity( cols ) ; Might improve performance on huge tables??
Loop % cols
oRow[ A_Index ] := oFld.Item( A_Index - 1 ).Value
oRec.MoveNext() ; move the record pointer to the next row of values
}
oRec := oRec.NextRecordset() ; Get the next recordset.
}
If (txtout) ; If the user wants plaintext output, copy the results into a string
{
Query_Statement := "x"
Loop % o3DA.MaxIndex()
{
Query_Statement .= rd rd
oTbl := o3DA[ A_Index ]
Loop % oTbl.MaxIndex()
{
oRow := oTbl[ A_Index ]
Loop % oRow.MaxIndex()
If ( cd = "CSV" )
{
str := oRow[ A_Index ]
StringReplace, str, str, ", "", A
If !ErrorLevel || InStr( str, "," ) || InStr( str, rd )
str := """" str """"
Query_Statement .= ( A_Index = 1 ? rd : "," ) str
}
Else
Query_Statement .= ( A_Index = 1 ? rd : cd ) oRow[ A_Index ]
}
}
Query_Statement := SubStr( Query_Statement, 2 + 3 * StrLen( rd ) )
}
}
Else ; Oh NOES!! Put a description of each error in 'ADOSQL_LastError'.
{
oErr := oCon.Errors ; > http://www.w3schools.com/ado/ado_ref_error.asp
Query_Statement := "x"
Loop % oErr.Count
{
oFld := oErr.Item( A_Index - 1 )
str := oFld.Description
Query_Statement .= "`n`n" SubStr( str, 1 + InStr( str, "]", 0, 2 + InStr( str, "][", 0, 0 ) ) )
. "`n Number: " oFld.Number
. ", NativeError: " oFld.NativeError
. ", Source: " oFld.Source
. ", SQLState: " oFld.SQLState
}
ADOSQL_LastError := SubStr( Query_Statement, 4 )
Query_Statement := ""
txtout := 1
}
; Close the connection and return the result. Local objects are cleaned up as the function returns.
oCon.Close()
ComObjError( 1 )
ErrorLevel := coer
Return txtout ? Query_Statement : o3DA.MaxIndex() = 1 ? o3DA[1] : o3DA
} ; END - ADOSQL( Connection_String, Query_Statement )