data.json
18.2 KB
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
{
"project": {},
"files": {
"lib/dialects/abstract/query.js": {
"name": "lib/dialects/abstract/query.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"lib/dialects/sqlite/query-interface.js": {
"name": "lib/dialects/sqlite/query-interface.js",
"modules": {},
"classes": {
"QueryInterface": 1
},
"fors": {
"QueryInterface": 1
},
"namespaces": {}
},
"lib/dao-factory.js": {
"name": "lib/dao-factory.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"lib/sequelize.js": {
"name": "lib/sequelize.js",
"modules": {},
"classes": {
"Sequelize": 1
},
"fors": {},
"namespaces": {}
},
"index.js": {
"name": "index.js",
"modules": {
"Sequelize": 1
},
"classes": {},
"fors": {},
"namespaces": {}
}
},
"modules": {
"Sequelize": {
"name": "Sequelize",
"submodules": {},
"classes": {
"QueryInterface": 1,
"Sequelize": 1
},
"fors": {},
"namespaces": {},
"tag": "module",
"file": "lib/sequelize.js",
"line": 12,
"description": "The entry point."
}
},
"classes": {
"QueryInterface": {
"name": "QueryInterface",
"shortname": "QueryInterface",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Sequelize",
"file": "lib/dialects/sqlite/query-interface.js",
"line": 3,
"description": "Returns an object that treats SQLite's inabilities to do certain queries.",
"static": 1
},
"Sequelize": {
"name": "Sequelize",
"shortname": "Sequelize",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "Sequelize",
"file": "lib/sequelize.js",
"line": 12,
"description": "Main class of the project.",
"params": [
{
"name": "database",
"description": "The name of the database.",
"type": "String"
},
{
"name": "username",
"description": "The username which is used to authenticate against the database.",
"type": "String"
},
{
"name": "password",
"description": "The password which is used to authenticate against the database.",
"type": "String",
"optional": true
},
{
"name": "options",
"description": "An object with options.",
"type": "Object",
"optional": true
}
],
"example": [
"\n // without password and options\n var sequelize = new Sequelize('database', 'username')\n\n // without options\n var sequelize = new Sequelize('database', 'username', 'password')\n\n // without password / with blank password\n var sequelize = new Sequelize('database', 'username', null, {})\n\n // with password and options\n var sequelize = new Sequelize('my_database', 'john', 'doe', {})"
],
"is_constructor": 1
}
},
"classitems": [
{
"file": "lib/dialects/abstract/query.js",
"line": 8,
"description": "Inherit from CustomEventEmitter",
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 13,
"description": "Execute the passed sql query.\n\nExamples:\n\n query.run('SELECT 1')",
"params": [
{
"name": "sql",
"description": "- The SQL query which should be executed.",
"type": "String"
}
],
"api": "public",
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 27,
"description": "Check the logging option of the instance and print deprecation warnings.",
"return": {
"description": "",
"type": "Void"
},
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 44,
"description": "High level function that handles the results of a query execution.\n\n\nExample:\n query.formatResults([\n {\n id: 1, // this is from the main table\n attr2: 'snafu', // this is from the main table\n Tasks.id: 1, // this is from the associated table\n Tasks.title: 'task' // this is from the associated table\n }\n ])",
"params": [
{
"name": "data",
"description": "- The result of the query execution.",
"type": "Array"
}
],
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 102,
"description": "Shortcut methods (success, ok) for listening for success events.\n\nParams:\n - fct: A function that gets executed once the *success* event was triggered.\n\nResult:\n The function returns the instance of the query.",
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 118,
"description": "Shortcut methods (failure, fail, error) for listening for error events.\n\nParams:\n - fct: A function that gets executed once the *error* event was triggered.\n\nResult:\n The function returns the instance of the query.",
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 135,
"description": "This function is a wrapper for private methods.",
"params": [
{
"name": "fctName",
"description": "The name of the private method.",
"type": "String"
}
],
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 146,
"description": "Get the attributes of an insert query, which contains the just inserted id.",
"return": {
"description": "The field name.",
"type": "String"
},
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 159,
"description": "Iterate over all known tables and search their names inside the sql query.\nThis method will also check association aliases ('as' option).",
"params": [
{
"name": "attribute",
"description": "An attribute of a SQL query. (?)",
"type": "String"
}
],
"return": {
"description": "The found tableName / alias.",
"type": "String"
},
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 345,
"description": "The function takes the result of the query execution and groups\nthe associated data by the callee.\n\nExample:\n groupDataByCalleeFactory([\n {\n callee: { some: 'data', id: 1 },\n association: { foo: 'bar', id: 1 }\n }, {\n callee: { some: 'data', id: 1 },\n association: { foo: 'bar', id: 2 }\n }, {\n callee: { some: 'data', id: 1 },\n association: { foo: 'bar', id: 3 }\n }\n ])\n\nResult:\n Something like this:\n\n [\n {\n callee: { some: 'data', id: 1 },\n association: [\n { foo: 'bar', id: 1 },\n { foo: 'bar', id: 2 },\n { foo: 'bar', id: 3 }\n ]\n }\n ]",
"class": "QueryInterface"
},
{
"file": "lib/dialects/abstract/query.js",
"line": 405,
"description": "This function will prepare the result of select queries with joins.",
"params": [
{
"name": "data",
"description": "This array contains objects.",
"type": "Array"
}
],
"return": {
"description": "The array will have the needed format for groupDataByCalleeFactory.",
"type": "Array"
},
"class": "QueryInterface"
},
{
"file": "lib/dialects/sqlite/query-interface.js",
"line": 10,
"description": "A wrapper that fixes SQLite's inability to remove columns from existing tables.\nIt will create a backup of the table, drop the table afterwards and create a\nnew table with the same name but without the obsolete column.",
"itemtype": "method",
"name": "removeColumn",
"params": [
{
"name": "tableName",
"description": "The name of the table.",
"type": "String"
},
{
"name": "attributeName",
"description": "The name of the attribute that we want to remove.",
"type": "String"
},
{
"name": "emitter",
"description": "The EventEmitter from outside.",
"type": "CustomEventEmitter"
},
{
"name": "queryAndEmit",
"description": "The function from outside that triggers some events to get triggered.",
"type": "Function"
}
],
"since": "1.6.0",
"class": "QueryInterface"
},
{
"file": "lib/dialects/sqlite/query-interface.js",
"line": 40,
"description": "A wrapper that fixes SQLite's inability to change columns from existing tables.\nIt will create a backup of the table, drop the table afterwards and create a\nnew table with the same name but with a modified version of the respective column.",
"itemtype": "method",
"name": "changeColumn",
"params": [
{
"name": "tableName",
"description": "The name of the table.",
"type": "String"
},
{
"name": "attributes",
"description": "An object with the attribute's name as key and it's options as value object.",
"type": "Object"
},
{
"name": "emitter",
"description": "The EventEmitter from outside.",
"type": "CustomEventEmitter"
},
{
"name": "queryAndEmit",
"description": "The function from outside that triggers some events to get triggered.",
"type": "Function"
}
],
"since": "1.6.0",
"class": "QueryInterface"
},
{
"file": "lib/dialects/sqlite/query-interface.js",
"line": 72,
"description": "A wrapper that fixes SQLite's inability to rename columns from existing tables.\nIt will create a backup of the table, drop the table afterwards and create a\nnew table with the same name but with a renamed version of the respective column.",
"itemtype": "method",
"name": "renameColumn",
"params": [
{
"name": "tableName",
"description": "The name of the table.",
"type": "String"
},
{
"name": "attrNameBefore",
"description": "The name of the attribute before it was renamed.",
"type": "String"
},
{
"name": "attrNameAfter",
"description": "The name of the attribute after it was renamed.",
"type": "String"
},
{
"name": "emitter",
"description": "The EventEmitter from outside.",
"type": "CustomEventEmitter"
},
{
"name": "queryAndEmit",
"description": "The function from outside that triggers some events to get triggered.",
"type": "Function"
}
],
"since": "1.6.0",
"class": "QueryInterface"
},
{
"file": "lib/dao-factory.js",
"line": 178,
"description": "Search for an instance.",
"params": [
{
"name": "options",
"description": "Options to describe the scope of the search.",
"type": "Object"
},
{
"name": "include",
"description": "A list of associations which shall get eagerly loaded. Supported is either { include: [ DaoFactory1, DaoFactory2, ...] } or { include: [ { daoFactory: DaoFactory1, as: 'Alias' } ] }.",
"type": "Array"
}
],
"return": {
"description": "A promise which fires `success`, `error`, `complete` and `sql`.",
"type": "Object"
},
"class": "Sequelize"
},
{
"file": "lib/sequelize.js",
"line": 80,
"description": "Reference to Utils",
"class": "Sequelize"
}
],
"warnings": [
{
"message": "unknown tag: api",
"line": " lib/dialects/abstract/query.js:13"
},
{
"message": "Missing item type\nInherit from CustomEventEmitter",
"line": " lib/dialects/abstract/query.js:8"
},
{
"message": "Missing item type\nExecute the passed sql query.\n\nExamples:\n\n query.run('SELECT 1')",
"line": " lib/dialects/abstract/query.js:13"
},
{
"message": "Missing item type\nCheck the logging option of the instance and print deprecation warnings.",
"line": " lib/dialects/abstract/query.js:27"
},
{
"message": "Missing item type\nHigh level function that handles the results of a query execution.\n\n\nExample:\n query.formatResults([\n {\n id: 1, // this is from the main table\n attr2: 'snafu', // this is from the main table\n Tasks.id: 1, // this is from the associated table\n Tasks.title: 'task' // this is from the associated table\n }\n ])",
"line": " lib/dialects/abstract/query.js:44"
},
{
"message": "Missing item type\nShortcut methods (success, ok) for listening for success events.\n\nParams:\n - fct: A function that gets executed once the *success* event was triggered.\n\nResult:\n The function returns the instance of the query.",
"line": " lib/dialects/abstract/query.js:102"
},
{
"message": "Missing item type\nShortcut methods (failure, fail, error) for listening for error events.\n\nParams:\n - fct: A function that gets executed once the *error* event was triggered.\n\nResult:\n The function returns the instance of the query.",
"line": " lib/dialects/abstract/query.js:118"
},
{
"message": "Missing item type\nThis function is a wrapper for private methods.",
"line": " lib/dialects/abstract/query.js:135"
},
{
"message": "Missing item type\nGet the attributes of an insert query, which contains the just inserted id.",
"line": " lib/dialects/abstract/query.js:146"
},
{
"message": "Missing item type\nIterate over all known tables and search their names inside the sql query.\nThis method will also check association aliases ('as' option).",
"line": " lib/dialects/abstract/query.js:159"
},
{
"message": "Missing item type\nThe function takes the result of the query execution and groups\nthe associated data by the callee.\n\nExample:\n groupDataByCalleeFactory([\n {\n callee: { some: 'data', id: 1 },\n association: { foo: 'bar', id: 1 }\n }, {\n callee: { some: 'data', id: 1 },\n association: { foo: 'bar', id: 2 }\n }, {\n callee: { some: 'data', id: 1 },\n association: { foo: 'bar', id: 3 }\n }\n ])\n\nResult:\n Something like this:\n\n [\n {\n callee: { some: 'data', id: 1 },\n association: [\n { foo: 'bar', id: 1 },\n { foo: 'bar', id: 2 },\n { foo: 'bar', id: 3 }\n ]\n }\n ]",
"line": " lib/dialects/abstract/query.js:345"
},
{
"message": "Missing item type\nThis function will prepare the result of select queries with joins.",
"line": " lib/dialects/abstract/query.js:405"
},
{
"message": "Missing item type\nSearch for an instance.",
"line": " lib/dao-factory.js:178"
},
{
"message": "Missing item type\nReference to Utils",
"line": " lib/sequelize.js:80"
}
]
}