-
Notifications
You must be signed in to change notification settings - Fork 77
/
Copy pathodbc.d.ts
210 lines (146 loc) · 9.38 KB
/
odbc.d.ts
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
declare namespace odbc {
class ColumnDefinition {
name: string;
dataType: number;
dataTypeName: string;
columnSize: number;
decimalDigits: number;
nullable: boolean;
}
class Result<T> extends Array<T> {
count: number;
columns: Array<ColumnDefinition>;
statement: string;
parameters: Array<number|string>;
return: number;
}
class OdbcError {
message: string;
code: number;
state: string;
}
class NodeOdbcError extends Error {
odbcErrors: Array<OdbcError>;
}
class Statement {
////////////////////////////////////////////////////////////////////////////
// Callbacks ///////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
prepare(sql: string, callback: (error: NodeOdbcError) => undefined): undefined;
bind(parameters: Array<number|string>, callback: (error: NodeOdbcError) => undefined): undefined;
execute<T>(callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
close(callback: (error: NodeOdbcError) => undefined): undefined;
////////////////////////////////////////////////////////////////////////////
// Promises ////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
prepare(sql: string): Promise<void>;
bind(parameters: Array<number|string>): Promise<void>;
execute<T>(): Promise<Result<T>>;
close(): Promise<void>;
}
interface ConnectionParameters {
connectionString: string;
connectionTimeout?: number;
loginTimeout?: number;
}
interface PoolParameters {
connectionString: string;
connectionTimeout?: number;
loginTimeout?: number;
initialSize?: number;
incrementSize?: number;
maxSize?: number;
reuseConnections?: boolean;
shrink?: boolean;
}
interface QueryOptions {
cursor?: boolean|string;
fetchSize?: number;
timeout?: number;
initialBufferSize?: number;
}
interface CursorQueryOptions extends QueryOptions {
cursor: boolean|string
}
class Connection {
////////////////////////////////////////////////////////////////////////////
// Callbacks ///////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
query<T>(sql: string, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
query<T>(sql: string, parameters: Array<number|string>, callback: (error: NodeOdbcError, result: Result<T> | Cursor) => undefined): undefined;
query<T, O extends QueryOptions>(sql: string, options: O, callback: (error: NodeOdbcError, result: O extends CursorQueryOptions ? Cursor : Result<T>) => undefined): undefined;
query<T, O extends QueryOptions>(sql: string, parameters: Array<number|string>, options: O, callback: (error: NodeOdbcError, result: O extends CursorQueryOptions ? Cursor : Result<T>) => undefined): undefined;
callProcedure<T>(catalog: string|null, schema: string|null, name: string, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
callProcedure<T>(catalog: string|null, schema: string|null, name: string, parameters: Array<number|string>, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
createStatement(callback: (error: NodeOdbcError, statement: Statement) => undefined): undefined;
primaryKeys<T>(catalog: string|null, schema: string|null, table: string|null, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
foreignKeys<T>(pkCatalog: string|null, pkSchema: string|null, pkTable: string|null, fkCatalog: string|null, fkSchema: string|null, fkTable: string|null, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
tables<T>(catalog: string|null, schema: string|null, table: string|null, type: string|null, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
columns<T>(catalog: string|null, schema: string|null, table: string|null, column: string|null, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
setIsolationLevel(level: number, callback: (error: NodeOdbcError) => undefined): undefined;
beginTransaction(callback: (error: NodeOdbcError) => undefined): undefined;
commit(callback: (error: NodeOdbcError) => undefined): undefined;
rollback(callback: (error: NodeOdbcError) => undefined): undefined;
close(callback: (error: NodeOdbcError) => undefined): undefined;
////////////////////////////////////////////////////////////////////////////
// Promises ////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
query<T>(sql: string): Promise<Result<T>>;
query<T>(sql: string, parameters: Array<number|string>): Promise<Result<T>>;
query<T, O extends QueryOptions>(sql: string, options: O): O extends CursorQueryOptions ? Promise<Cursor> : Promise<Result<T>>;
query<T, O extends QueryOptions>(sql: string, parameters: Array<number|string>, options: O): O extends CursorQueryOptions ? Promise<Cursor> : Promise<Result<T>>;
callProcedure<T>(catalog: string|null, schema: string|null, name: string, parameters?: Array<number|string>): Promise<Result<T>>;
createStatement(): Promise<Statement>;
primaryKeys<T>(catalog: string|null, schema: string|null, table: string|null): Promise<Result<T>>;
foreignKeys<T>(pkCatalog: string|null, pkSchema: string|null, pkTable: string|null, fkCatalog: string|null, fkSchema: string|null, fkTable: string|null): Promise<Result<T>>;
tables<T>(catalog: string|null, schema: string|null, table: string|null, type: string|null): Promise<Result<T>>;
columns<T>(catalog: string|null, schema: string|null, table: string|null, column: string|null): Promise<Result<T>>;
setIsolationLevel(level: number): Promise<void>;
beginTransaction(): Promise<void>;
commit(): Promise<void>;
rollback(): Promise<void>;
close(): Promise<void>;
}
class Pool {
////////////////////////////////////////////////////////////////////////////
// Callbacks ///////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
connect(callback: (error: NodeOdbcError, connection: Connection) => undefined): undefined;
query<T>(sql: string, callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined;
query<T>(sql: string, parameters: Array<number|string>, callback: (error: NodeOdbcError, result: Result<T> | Cursor) => undefined): undefined;
query<T, O extends QueryOptions>(sql: string, options: O, callback: (error: NodeOdbcError, result: O extends CursorQueryOptions ? Cursor : Result<T>) => undefined): undefined;
query<T, O extends QueryOptions>(sql: string, parameters: Array<number|string>, options: O, callback: (error: NodeOdbcError, result: O extends CursorQueryOptions ? Cursor : Result<T>) => undefined): undefined;
close(callback: (error: NodeOdbcError) => undefined): undefined;
////////////////////////////////////////////////////////////////////////////
// Promises ////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
connect(): Promise<Connection>;
query<T>(sql: string): Promise<Result<T>>;
query<T>(sql: string, parameters: Array<number|string>): Promise<Result<T>>;
query<T, O extends QueryOptions>(sql: string, options: O): O extends CursorQueryOptions ? Promise<Cursor> : Promise<Result<T>>;
query<T, O extends QueryOptions>(sql: string, parameters: Array<number|string>, options: O): O extends CursorQueryOptions ? Promise<Cursor> : Promise<Result<T>>;
close(): Promise<void>;
}
class Cursor {
noData: boolean
////////////////////////////////////////////////////////////////////////////
// Promises ////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
fetch<T>(): Promise<Result<T>>
close(): Promise<void>
////////////////////////////////////////////////////////////////////////////
// Callbacks ///////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
fetch<T>(callback: (error: NodeOdbcError, result: Result<T>) => undefined): undefined
close(callback: (error: NodeOdbcError) => undefined): undefined
}
function connect(connectionString: string, callback: (error: NodeOdbcError, connection: Connection) => undefined): undefined;
function connect(connectionObject: ConnectionParameters, callback: (error: NodeOdbcError, connection: Connection) => undefined): undefined;
function connect(connectionString: string): Promise<Connection>;
function connect(connectionObject: ConnectionParameters): Promise<Connection>;
function pool(connectionString: string, callback: (error: NodeOdbcError, pool: Pool) => undefined): undefined;
function pool(connectionObject: PoolParameters, callback: (error: NodeOdbcError, pool: Pool) => undefined): undefined;
function pool(connectionString: string): Promise<Pool>;
function pool(connectionObject: PoolParameters): Promise<Pool>;
}
export = odbc;