-
Notifications
You must be signed in to change notification settings - Fork 242
/
Sidebar.jsx
383 lines (356 loc) · 21.4 KB
/
Sidebar.jsx
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
import React, { Component } from 'react'
export default class Sidebar extends Component {
render() {
return (
<div id="sidebar" className="interface">
<a className="toc_title" href="#changelog">
Knex.js <span className="version">({this.props.version})</span>
</a>
<ul className="toc_section">
<li>» <a href="https://github.com/knex/knex">GitHub Repository</a></li>
<li>» <a href="#support">Support</a></li>
<li>» <a href="#faq">FAQ</a></li>
<li>» <a href="#changelog">Change Log</a></li>
</ul>
<a className="toc_title" href="#Installation">
Installation
</a>
<ul className="toc_section">
<li>– <a href="#Installation-node">Node.js</a></li>
<li>– <a href="#Installation-browser">Browser</a></li>
<li><b><a href="#Installation-client">Config Options:</a></b></li>
<li> – <a href="#Installation-client">client</a></li>
<li> – <a href="#Installation-debug">debug</a></li>
<li> – <a href="#Installation-parametrization">Getting parametrized instance</a></li>
<li> – <a href="#Installation-asyncStackTraces">Async stacktraces</a></li>
<li> – <a href="#Installation-pooling">Pooling</a></li>
<li> – <a href="#Installation-pooling-afterCreate">afterCreate</a></li>
<li> – <a href="#Installation-acquireConnectionTimeout">acquireConnectionTimeout</a></li>
<li> – <a href="#Installation-fetchAsString">fetchAsString</a></li>
<li> – <a href="#Installation-migrations">Migrations</a></li>
<li> – <a href="#Installation-post-process-response">postProcessResponse</a></li>
<li> – <a href="#Installation-wrap-identifier">wrapIdentifier</a></li>
<li> – <a href="#Installation-log">log</a></li>
</ul>
<a className="toc_title" href="#typescript-support">
TypeScript Support
</a>
<a className="toc_title" href="#Builder">
Query Builder
</a>
<ul className="toc_section">
<li>– <a href="#Builder-identifier-syntax"><b>Identifier Syntax</b></a></li>
<li>– <a href="#Builder-knex"><b>constructor</b></a></li>
<li>– <a href="#Builder-timeout">timeout</a></li>
<li>– <a href="#Builder-select">select</a></li>
<li>– <a href="#Builder-as">as</a></li>
<li>– <a href="#Builder-column">column</a></li>
<li>– <a href="#Builder-from">from</a></li>
<li>– <a href="#Builder-fromRaw">fromRaw</a></li>
<li>– <a href="#Builder-with">with</a></li>
<li>– <a href="#Builder-withRecursive">withRecursive</a></li>
<li>– <a href="#Builder-jsonExtract">jsonExtract</a></li>
<li>– <a href="#Builder-jsonSet">jsonSet</a></li>
<li>– <a href="#Builder-jsonInsert">jsonInsert</a></li>
<li>– <a href="#Builder-jsonRemove">jsonRemove</a></li>
<li><b><a href="#Builder-wheres">Where Methods:</a></b></li>
<li> – <a href="#Builder-where">where</a></li>
<li> – <a href="#Builder-whereNot">whereNot</a></li>
<li> – <a href="#Builder-whereIn">whereIn</a></li>
<li> – <a href="#Builder-whereNotIn">whereNotIn</a></li>
<li> – <a href="#Builder-whereNull">whereNull</a></li>
<li> – <a href="#Builder-whereNotNull">whereNotNull</a></li>
<li> – <a href="#Builder-whereExists">whereExists</a></li>
<li> – <a href="#Builder-whereNotExists">whereNotExists</a></li>
<li> – <a href="#Builder-whereBetween">whereBetween</a></li>
<li> – <a href="#Builder-whereNotBetween">whereNotBetween</a></li>
<li> – <a href="#Builder-whereRaw">whereRaw</a></li>
<li> – <a href="#Builder-whereLike">whereLike</a></li>
<li> – <a href="#Builder-whereILike">whereILike</a></li>
<li> – <a href="#Builder-whereJsonObject">whereJsonObject</a></li>
<li> – <a href="#Builder-whereJsonPath">whereJsonPath</a></li>
<li> – <a href="#Builder-whereJsonSupersetOf">whereJsonSupersetOf</a></li>
<li> – <a href="#Builder-whereJsonSubsetOf">whereJsonSubsetOf</a></li>
<li><b><a href="#Builder-join">Join Methods:</a></b></li>
<li> – <a href="#Builder-join">join</a></li>
<li> – <a href="#Builder-innerJoin">innerJoin</a></li>
<li> – <a href="#Builder-leftJoin">leftJoin</a></li>
<li> – <a href="#Builder-leftOuterJoin">leftOuterJoin</a></li>
<li> – <a href="#Builder-rightJoin">rightJoin</a></li>
<li> – <a href="#Builder-rightOuterJoin">rightOuterJoin</a></li>
<li> – <a href="#Builder-fullOuterJoin">fullOuterJoin</a></li>
<li> – <a href="#Builder-crossJoin">crossJoin</a></li>
<li> – <a href="#Builder-joinRaw">joinRaw</a></li>
<li><b><a href="#Builder-on">On Methods:</a></b></li>
<li> – <a href="#Builder-onIn">onIn</a></li>
<li> – <a href="#Builder-onNotIn">onNotIn</a></li>
<li> – <a href="#Builder-onNull">onNull</a></li>
<li> – <a href="#Builder-onNotNull">onNotNull</a></li>
<li> – <a href="#Builder-onExists">onExists</a></li>
<li> – <a href="#Builder-onNotExists">onNotExists</a></li>
<li> – <a href="#Builder-onBetween">onBetween</a></li>
<li> – <a href="#Builder-onNotBetween">onNotBetween</a></li>
<li> – <a href="#Builder-onJsonPathEquals">onJsonPathEquals</a></li>
<li><b><a href="#Builder-clear">Clear Methods:</a></b></li>
<li> – <a href="#Builder-clear">clear</a></li>
<li> – <a href="#Builder-clearSelect">clearSelect (deprecated)</a></li>
<li> – <a href="#Builder-clearWhere">clearWhere (deprecated)</a></li>
<li> – <a href="#Builder-clearOrder">clearOrder (deprecated)</a></li>
<li> – <a href="#Builder-clearHaving">clearHaving (deprecated)</a></li>
<li> – <a href="#Builder-clearCounters">clearCounters</a></li>
<li><b><a href="#Builder-havings">Having Methods:</a></b></li>
<li> – <a href="#Builder-having">having</a></li>
<li> – <a href="#Builder-havingIn">havingIn</a></li>
<li> – <a href="#Builder-havingNotIn">havingNotIn</a></li>
<li> – <a href="#Builder-havingNull">havingNull</a></li>
<li> – <a href="#Builder-havingNotNull">havingNotNull</a></li>
<li> – <a href="#Builder-havingExists">havingExists</a></li>
<li> – <a href="#Builder-havingNotExists">havingNotExists</a></li>
<li> – <a href="#Builder-havingBetween">havingBetween</a></li>
<li> – <a href="#Builder-havingNotBetween">havingNotBetween</a></li>
<li> – <a href="#Builder-havingRaw">havingRaw</a></li>
<li>– <a href="#Builder-distinct">distinct</a></li>
<li>– <a href="#Builder-distinctOn">distinctOn</a></li>
<li>– <a href="#Builder-groupBy">groupBy</a></li>
<li>– <a href="#Builder-groupByRaw">groupByRaw</a></li>
<li>– <a href="#Builder-orderBy">orderBy</a></li>
<li>– <a href="#Builder-orderByRaw">orderByRaw</a></li>
<li>– <a href="#Builder-offset">offset</a></li>
<li>– <a href="#Builder-limit">limit</a></li>
<li>– <a href="#Builder-union">union</a></li>
<li>– <a href="#Builder-unionAll">unionAll</a></li>
<li>– <a href="#Builder-insert">insert</a></li>
<li>– <a href="#Builder-onConflict">onConflict</a></li>
<li> – <a href="#Builder-ignore">ignore</a></li>
<li> – <a href="#Builder-merge">merge</a></li>
<li>– <a href="#Builder-upsert">upsert</a></li>
<li>– <a href="#Builder-update">update</a></li>
<li>– <a href="#Builder-del / delete">del / delete</a></li>
<li>– <a href="#Builder-using">using</a></li>
<li>– <a href="#Builder-returning">returning</a></li>
<li>– <a href="#Builder-transacting">transacting</a></li>
<li> – <a href="#Builder-forUpdate">forUpdate</a></li>
<li> – <a href="#Builder-forShare">forShare</a></li>
<li> – <a href="#Builder-forNoKeyUpdate">forNoKeyUpdate</a></li>
<li> – <a href="#Builder-forKeyShare">forKeyShare</a></li>
<li>– <a href="#Builder-skipLocked">skipLocked</a></li>
<li>– <a href="#Builder-noWait">noWait</a></li>
<li>– <a href="#Builder-count">count</a></li>
<li>– <a href="#Builder-min">min</a></li>
<li>– <a href="#Builder-max">max</a></li>
<li>– <a href="#Builder-sum">sum</a></li>
<li>– <a href="#Builder-avg">avg</a></li>
<li>– <a href="#Builder-increment">increment</a></li>
<li>– <a href="#Builder-decrement">decrement</a></li>
<li>– <a href="#Builder-hintComment">hintComment</a></li>
<li>– <a href="#Builder-truncate">truncate</a></li>
<li>– <a href="#Builder-pluck">pluck</a></li>
<li>– <a href="#Builder-first">first</a></li>
<li>– <a href="#Builder-clone">clone</a></li>
<li>– <a href="#Builder-rank">rank</a></li>
<li>– <a href="#Builder-denseRank">denseRank</a></li>
<li>– <a href="#Builder-rowNumber">rowNumber</a></li>
<li>– <a href="#Builder-partitionBy">partitionBy</a></li>
<li>– <a href="#Builder-modify">modify</a></li>
<li>– <a href="#Builder-columnInfo">columnInfo</a></li>
<li>– <a href="#Builder-debug">debug</a></li>
<li>– <a href="#Builder-connection">connection</a></li>
<li>– <a href="#Builder-options">options</a></li>
<li>- <a href="#Builder-queryContext">queryContext</a></li>
</ul>
<a className="toc_title" href="#Transactions">
Transactions
</a>
<ul className="toc_section">
<li>– <a href="#Transactions"><b>overview</b></a></li>
</ul>
<a className="toc_title" href="#Schema">
Schema Builder
</a>
<ul className="toc_section">
<li>– <a href="#Schema-withSchema">withSchema</a></li>
<li>– <a href="#Schema-createTable">createTable</a></li>
<li>– <a href="#Schema-createTableLike">createTableLike</a></li>
<li>– <a href="#Schema-renameTable">renameTable</a></li>
<li>– <a href="#Schema-dropTable">dropTable</a></li>
<li>– <a href="#Schema-hasColumn">hasColumn</a></li>
<li>– <a href="#Schema-hasTable">hasTable</a></li>
<li>– <a href="#Schema-dropTableIfExists">dropTableIfExists</a></li>
<li>– <a href="#Schema-table">table</a></li>
<li>– <a href="#Schema-alterTable">alterTable</a></li>
<li>– <a href="#Schema-createView">createView</a></li>
<li>– <a href="#Schema-createViewOrReplace">createViewOrReplace</a></li>
<li>– <a href="#Schema-createMaterializedView">createMaterializedView</a></li>
<li>– <a href="#Schema-refreshMaterializedView">refreshMaterializedView</a></li>
<li>– <a href="#Schema-dropView">dropView</a></li>
<li>– <a href="#Schema-dropViewIfExists">dropViewIfExists</a></li>
<li>– <a href="#Schema-dropMaterializedView">dropMaterializedView</a></li>
<li>– <a href="#Schema-dropMaterializedViewIfExists">dropMaterializedViewIfExists</a></li>
<li>– <a href="#Schema-renameView">renameView</a></li>
<li>– <a href="#Schema-alterView">alterView</a></li>
<li>– <a href="#Schema-generateDdlCommands">generateDdlCommands</a></li>
<li>– <a href="#Schema-raw">raw</a></li>
<li>– <a href="#Schema-queryContext">queryContext</a></li>
<li>– <a href="#Schema-dropSchema">dropSchema</a></li>
<li>– <a href="#Schema-dropSchemaIfExists">dropSchemaIfExists</a></li>
<li><b><a href="#Schema-Building">Schema Building:</a></b></li>
<li>– <a href="#Schema-dropColumn">dropColumn</a></li>
<li>– <a href="#Schema-dropColumns">dropColumns</a></li>
<li>– <a href="#Schema-renameColumn">renameColumn</a></li>
<li>– <a href="#Schema-increments">increments</a></li>
<li>– <a href="#Schema-integer">integer</a></li>
<li>– <a href="#Schema-bigInteger">bigInteger</a></li>
<li>– <a href="#Schema-text">text</a></li>
<li>– <a href="#Schema-string">string</a></li>
<li>– <a href="#Schema-float">float</a></li>
<li>– <a href="#Schema-double">double</a></li>
<li>– <a href="#Schema-decimal">decimal</a></li>
<li>– <a href="#Schema-boolean">boolean</a></li>
<li>– <a href="#Schema-date">date</a></li>
<li>– <a href="#Schema-datetime">datetime</a></li>
<li>– <a href="#Schema-time">time</a></li>
<li>– <a href="#Schema-timestamp">timestamp</a></li>
<li>– <a href="#Schema-timestamps">timestamps</a></li>
<li>– <a href="#Schema-dropTimestamps">dropTimestamps</a></li>
<li>– <a href="#Schema-binary">binary</a></li>
<li>– <a href="#Schema-enum">enum / enu</a></li>
<li>– <a href="#Schema-json">json</a></li>
<li>– <a href="#Schema-jsonb">jsonb</a></li>
<li>– <a href="#Schema-uuid">uuid</a></li>
<li>– <a href="#Schema-geometry">geometry</a></li>
<li>– <a href="#Schema-geography">geography</a></li>
<li>– <a href="#Schema-point">point</a></li>
<li>– <a href="#Schema-comment">comment</a></li>
<li>– <a href="#Schema-engine">engine</a></li>
<li>– <a href="#Schema-charset">charset</a></li>
<li>– <a href="#Schema-collate">collate</a></li>
<li>– <a href="#Schema-inherits">inherits</a></li>
<li>– <a href="#Schema-specificType">specificType</a></li>
<li>– <a href="#Schema-index">index</a></li>
<li>– <a href="#Schema-dropIndex">dropIndex</a></li>
<li>– <a href="#Schema-setNullable">setNullable</a></li>
<li>– <a href="#Schema-dropNullable">dropNullable</a></li>
<li>– <a href="#Schema-table-primary">primary</a></li>
<li>– <a href="#Schema-table-unique">unique</a></li>
<li>– <a href="#Schema-foreign">foreign</a></li>
<li>– <a href="#Schema-dropForeign">dropForeign</a></li>
<li>– <a href="#Schema-dropUnique">dropUnique</a></li>
<li>– <a href="#Schema-dropPrimary">dropPrimary</a></li>
<li>– <a href="#Schema-table-queryContext">queryContext</a></li>
<li><a href="#Chainable"><b>Chainable:</b></a></li>
<li>– <a href="#Schema-alter">alter</a></li>
<li>– <a href="#Schema-index">index</a></li>
<li>– <a href="#Schema-column-primary">primary</a></li>
<li>– <a href="#Schema-column-unique">unique</a></li>
<li>– <a href="#Schema-references">references</a></li>
<li>– <a href="#Schema-inTable">inTable</a></li>
<li>– <a href="#Schema-onDelete">onDelete</a></li>
<li>– <a href="#Schema-onUpdate">onUpdate</a></li>
<li>– <a href="#Schema-defaultTo">defaultTo</a></li>
<li>– <a href="#Schema-unsigned">unsigned</a></li>
<li>– <a href="#Schema-notNullable">notNullable</a></li>
<li>– <a href="#Schema-nullable">nullable</a></li>
<li>– <a href="#Schema-first">first</a></li>
<li>– <a href="#Schema-after">after</a></li>
<li>– <a href="#Column-comment">comment</a></li>
<li>– <a href="#Column-collate">collate</a></li>
<li><a href="#View"><b>View:</b></a></li>
<li>– <a href="#Schema-columns">columns</a></li>
<li>– <a href="#Schema-as">as</a></li>
<li>– <a href="#Schema-checkOption">checkOption</a></li>
<li>– <a href="#Schema-localCheckOption">localCheckOption</a></li>
<li>– <a href="#Schema-cascadedCheckOption">cascadedCheckOption</a></li>
<li><a href="#Checks"><b>Check:</b></a></li>
<li>– <a href="#Schema-check">check</a></li>
<li>– <a href="#Schema-checkPositive">checkPositive</a></li>
<li>– <a href="#Schema-checkNegative">checkNegative</a></li>
<li>– <a href="#Schema-checkIn">checkIn</a></li>
<li>– <a href="#Schema-checkNotIn">checkNotIn</a></li>
<li>– <a href="#Schema-checkBetween">checkBetween</a></li>
<li>– <a href="#Schema-checkLength">checkLength</a></li>
<li>– <a href="#Schema-checkRegex">checkRegex</a></li>
<li>– <a href="#Schema-dropChecks">dropChecks</a></li>
</ul>
<a className="toc_title" href="#Raw">
Raw
</a>
<ul className="toc_section">
<li>– <a href="#Raw-Bindings">Raw Parameter Binding</a></li>
<li>– <a href="#Raw-Expressions">Raw Expressions</a></li>
<li>– <a href="#Raw-Queries">Raw Queries</a></li>
<li>- <a href="#Raw-queries-wrapped">Wrapped Queries</a></li>
</ul>
<a className="toc_title" href="#Ref">
Ref
</a>
<ul className="toc_section">
<li>– <a href="#Ref-Usage">Usage</a></li>
<li>– <a href="#Ref-withSchema">withSchema</a></li>
<li>– <a href="#Ref-alias">alias</a></li>
</ul>
<a className="toc_title" href="#Utility">
Utility
</a>
<ul className="toc_section">
<li>- <a href="#Utility-BatchInsert">Batch Insert</a></li>
<li>- <a href="#Utility-now">now</a></li>
<li>- <a href="#Utility-binToUuid">binToUuid</a></li>
<li>- <a href="#Utility-uuidToBin">uuidToBin</a></li>
</ul>
<a className="toc_title" href="#Interfaces">
Interfaces
</a>
<ul className="toc_section">
<li><b><a href="#Interfaces-Promises">Promises</a></b></li>
<li> – <a href="#Interfaces-then">then</a></li>
<li> – <a href="#Interfaces-catch">catch</a></li>
<li><b><a href="#Interfaces-Callbacks">Callbacks</a></b></li>
<li> – <a href="#Interfaces-asCallback">asCallback</a></li>
<li><b><a href="#Interfaces-Streams">Streams</a></b></li>
<li> – <a href="#Interfaces-stream">stream</a></li>
<li> – <a href="#Interfaces-pipe">pipe</a></li>
<li><b><a href="#Interfaces-Events">Events</a></b></li>
<li> – <a href="#Interfaces-query">query</a></li>
<li> – <a href="#Interfaces-query-error">query-error</a></li>
<li> – <a href="#Interfaces-query-response">query-response</a></li>
<li><b><a href="#Interfaces-Other">Other:</a></b></li>
<li> – <a href="#Interfaces-toString">toString</a></li>
<li> – <a href="#Interfaces-toSQL">toSQL</a></li>
<li> – <a href="#Interfaces-toSQL">toSQL().toNative()</a></li>
</ul>
<a className="toc_title" href="#Migrations">
Migrations
</a>
<ul className="toc_section">
<li><a href="#Migrations-CLI"><b>CLI</b></a></li>
<li>– <a href="#Migrations-CLI">Migrations</a></li>
<li>– <a href="#Seeds-CLI">Seed files</a></li>
<li>– <a href="#knexfile">knexfile.js</a></li>
<li>– <a href="#esm-interop">esm</a></li>
<li><a href="#Migrations-API"><b>Migration API</b></a></li>
<li>– <a href="#Migrations-make">make</a></li>
<li>– <a href="#Migrations-latest">latest</a></li>
<li>– <a href="#Migrations-rollback">rollback</a></li>
<ii>- <a href="#Migrations-up">up</a></ii>
<ii>- <a href="#Migrations-down">down</a></ii>
<li>– <a href="#Migrations-currentVersion">currentVersion</a></li>
<li>– <a href="#Migrations-list">list</a></li>
<li>– <a href="#Migrations-unlock">unlock</a></li>
<li><a href="#Notes-about-locks"><b>Notes about locks</b></a></li>
<li><a href="#Seeds-API"><b>Seed API</b></a></li>
<li>– <a href="#Seeds-make">make</a></li>
<li>– <a href="#Seeds-run">run</a></li>
</ul>
<a className="toc_title" href="#support">
Support
</a>
<a className="toc_title" href="#faq">
F.A.Q.
</a>
<a className="toc_title" href="#changelog">
Change Log
</a>
</div>
)
}
}