undeexcepturi
Version:
TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.
2,469 lines (2,468 loc) • 1.4 MB
JSON
{
"id": 0,
"name": "mikro-orm",
"kind": 1,
"kindString": "Project",
"flags": {},
"originalName": "",
"children": [
{
"id": 212,
"name": "Cascade",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 216,
"name": "ALL",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 13,
"character": 2
}
],
"defaultValue": "\"all\""
},
{
"id": 214,
"name": "MERGE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 11,
"character": 2
}
],
"defaultValue": "\"merge\""
},
{
"id": 213,
"name": "PERSIST",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 10,
"character": 2
}
],
"defaultValue": "\"persist\""
},
{
"id": 215,
"name": "REMOVE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 12,
"character": 2
}
],
"defaultValue": "\"remove\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
216,
214,
213,
215
]
}
],
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 9,
"character": 12
}
]
},
{
"id": 1227,
"name": "ChangeSetType",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 1228,
"name": "CREATE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/ChangeSet.ts",
"line": 13,
"character": 2
}
],
"defaultValue": "\"create\""
},
{
"id": 1230,
"name": "DELETE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/ChangeSet.ts",
"line": 15,
"character": 2
}
],
"defaultValue": "\"delete\""
},
{
"id": 1229,
"name": "UPDATE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/ChangeSet.ts",
"line": 14,
"character": 2
}
],
"defaultValue": "\"update\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
1228,
1230,
1229
]
}
],
"sources": [
{
"fileName": "lib/unit-of-work/ChangeSet.ts",
"line": 12,
"character": 12
}
]
},
{
"id": 1212,
"name": "LockMode",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 1213,
"name": "NONE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/enums.ts",
"line": 2,
"character": 2
}
],
"defaultValue": "0"
},
{
"id": 1214,
"name": "OPTIMISTIC",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/enums.ts",
"line": 3,
"character": 2
}
],
"defaultValue": "1"
},
{
"id": 1215,
"name": "PESSIMISTIC_READ",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/enums.ts",
"line": 4,
"character": 2
}
],
"defaultValue": "2"
},
{
"id": 1216,
"name": "PESSIMISTIC_WRITE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/enums.ts",
"line": 5,
"character": 2
}
],
"defaultValue": "3"
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
1213,
1214,
1215,
1216
]
}
],
"sources": [
{
"fileName": "lib/unit-of-work/enums.ts",
"line": 1,
"character": 12
}
]
},
{
"id": 1337,
"name": "NodeState",
"kind": 8,
"kindString": "Enumeration",
"flags": {
"isConst": true
},
"children": [
{
"id": 1339,
"name": "IN_PROGRESS",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/CommitOrderCalculator.ts",
"line": 111,
"character": 2
}
],
"defaultValue": "1"
},
{
"id": 1338,
"name": "NOT_VISITED",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/CommitOrderCalculator.ts",
"line": 110,
"character": 2
}
],
"defaultValue": "0"
},
{
"id": 1340,
"name": "VISITED",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/unit-of-work/CommitOrderCalculator.ts",
"line": 112,
"character": 2
}
],
"defaultValue": "2"
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
1339,
1338,
1340
]
}
],
"sources": [
{
"fileName": "lib/unit-of-work/CommitOrderCalculator.ts",
"line": 109,
"character": 18
}
]
},
{
"id": 3864,
"name": "QueryFlag",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 3865,
"name": "DISTINCT",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 11,
"character": 2
}
],
"defaultValue": "\"DISTINCT\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
3865
]
}
],
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 10,
"character": 12
}
]
},
{
"id": 3866,
"name": "QueryOrder",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 3867,
"name": "ASC",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 15,
"character": 2
}
],
"defaultValue": "\"ASC\""
},
{
"id": 3868,
"name": "DESC",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 16,
"character": 2
}
],
"defaultValue": "\"DESC\""
},
{
"id": 3869,
"name": "asc",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 17,
"character": 2
}
],
"defaultValue": "\"asc\""
},
{
"id": 3870,
"name": "desc",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 18,
"character": 2
}
],
"defaultValue": "\"desc\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
3867,
3868,
3869,
3870
]
}
],
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 14,
"character": 12
}
]
},
{
"id": 3871,
"name": "QueryOrderNumeric",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 3872,
"name": "ASC",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 22,
"character": 2
}
],
"defaultValue": "1"
},
{
"id": 3873,
"name": "DESC",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 23,
"character": 2
}
],
"defaultValue": "-1"
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
3872,
3873
]
}
],
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 21,
"character": 12
}
]
},
{
"id": 3857,
"name": "QueryType",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 3860,
"name": "COUNT",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 4,
"character": 2
}
],
"defaultValue": "\"COUNT\""
},
{
"id": 3863,
"name": "DELETE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 7,
"character": 2
}
],
"defaultValue": "\"DELETE\""
},
{
"id": 3861,
"name": "INSERT",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 5,
"character": 2
}
],
"defaultValue": "\"INSERT\""
},
{
"id": 3859,
"name": "SELECT",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 3,
"character": 2
}
],
"defaultValue": "\"SELECT\""
},
{
"id": 3858,
"name": "TRUNCATE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 2,
"character": 2
}
],
"defaultValue": "\"TRUNCATE\""
},
{
"id": 3862,
"name": "UPDATE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 6,
"character": 2
}
],
"defaultValue": "\"UPDATE\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
3860,
3863,
3861,
3859,
3858,
3862
]
}
],
"sources": [
{
"fileName": "lib/query/enums.ts",
"line": 1,
"character": 12
}
]
},
{
"id": 206,
"name": "ReferenceType",
"kind": 8,
"kindString": "Enumeration",
"flags": {},
"children": [
{
"id": 211,
"name": "MANY_TO_MANY",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 6,
"character": 2
}
],
"defaultValue": "\"m:n\""
},
{
"id": 210,
"name": "MANY_TO_ONE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 5,
"character": 2
}
],
"defaultValue": "\"m:1\""
},
{
"id": 209,
"name": "ONE_TO_MANY",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 4,
"character": 2
}
],
"defaultValue": "\"1:m\""
},
{
"id": 208,
"name": "ONE_TO_ONE",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 3,
"character": 2
}
],
"defaultValue": "\"1:1\""
},
{
"id": 207,
"name": "SCALAR",
"kind": 16,
"kindString": "Enumeration member",
"flags": {},
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 2,
"character": 2
}
],
"defaultValue": "\"scalar\""
}
],
"groups": [
{
"title": "Enumeration members",
"kind": 16,
"children": [
211,
210,
209,
208,
207
]
}
],
"sources": [
{
"fileName": "lib/entity/enums.ts",
"line": 1,
"character": 12
}
]
},
{
"id": 3155,
"name": "AbstractNamingStrategy",
"kind": 128,
"kindString": "Class",
"flags": {
"isAbstract": true
},
"children": [
{
"id": 3156,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"signatures": [
{
"id": 3157,
"name": "new AbstractNamingStrategy",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"type": {
"type": "reference",
"id": 3155,
"name": "AbstractNamingStrategy"
}
}
]
},
{
"id": 3162,
"name": "classToTableName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 12,
"character": 11
}
],
"signatures": [
{
"id": 3163,
"name": "classToTableName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return a table name for an entity class"
},
"parameters": [
{
"id": 3164,
"name": "entityName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3136,
"name": "NamingStrategy.classToTableName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3135,
"name": "NamingStrategy.classToTableName"
}
},
{
"id": 3158,
"name": "getClassName",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 5,
"character": 2
}
],
"signatures": [
{
"id": 3159,
"name": "getClassName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return a name of the class based on its file name"
},
"parameters": [
{
"id": 3160,
"name": "file",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 3161,
"name": "separator",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "'-'"
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3132,
"name": "NamingStrategy.getClassName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3131,
"name": "NamingStrategy.getClassName"
}
},
{
"id": 3165,
"name": "joinColumnName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 14,
"character": 11
}
],
"signatures": [
{
"id": 3166,
"name": "joinColumnName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return a join column name for a property"
},
"parameters": [
{
"id": 3167,
"name": "propertyName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3144,
"name": "NamingStrategy.joinColumnName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3143,
"name": "NamingStrategy.joinColumnName"
}
},
{
"id": 3168,
"name": "joinKeyColumnName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 16,
"character": 11
}
],
"signatures": [
{
"id": 3169,
"name": "joinKeyColumnName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return the foreign key column name for the given parameters"
},
"parameters": [
{
"id": 3170,
"name": "entityName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 3171,
"name": "referencedColumnName",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3152,
"name": "NamingStrategy.joinKeyColumnName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3151,
"name": "NamingStrategy.joinKeyColumnName"
}
},
{
"id": 3172,
"name": "joinTableName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 18,
"character": 11
}
],
"signatures": [
{
"id": 3173,
"name": "joinTableName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return a join table name"
},
"parameters": [
{
"id": 3174,
"name": "sourceEntity",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 3175,
"name": "targetEntity",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 3176,
"name": "propertyName",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3147,
"name": "NamingStrategy.joinTableName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3146,
"name": "NamingStrategy.joinTableName"
}
},
{
"id": 3177,
"name": "propertyToColumnName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 20,
"character": 11
}
],
"signatures": [
{
"id": 3178,
"name": "propertyToColumnName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return a column name for a property"
},
"parameters": [
{
"id": 3179,
"name": "propertyName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3139,
"name": "NamingStrategy.propertyToColumnName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3138,
"name": "NamingStrategy.propertyToColumnName"
}
},
{
"id": 3180,
"name": "referenceColumnName",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 22,
"character": 11
}
],
"signatures": [
{
"id": 3181,
"name": "referenceColumnName",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Return the default reference column name"
},
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"id": 3142,
"name": "NamingStrategy.referenceColumnName"
}
}
],
"implementationOf": {
"type": "reference",
"id": 3141,
"name": "NamingStrategy.referenceColumnName"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
3156
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
3162,
3158,
3165,
3168,
3172,
3177,
3180
]
}
],
"sources": [
{
"fileName": "lib/naming-strategy/AbstractNamingStrategy.ts",
"line": 3,
"character": 22
}
],
"extendedBy": [
{
"type": "reference",
"id": 3182,
"name": "MongoNamingStrategy"
},
{
"type": "reference",
"id": 3209,
"name": "UnderscoreNamingStrategy"
},
{
"type": "reference",
"id": 3239,
"name": "EntityCaseNamingStrategy"
}
],
"implementedTypes": [
{
"type": "reference",
"id": 3130,
"name": "NamingStrategy"
}
]
},
{
"id": 2909,
"name": "AbstractSqlConnection",
"kind": 128,
"kindString": "Class",
"flags": {
"isAbstract": true
},
"children": [
{
"id": 2910,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"signatures": [
{
"id": 2911,
"name": "new AbstractSqlConnection",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 2912,
"name": "config",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 1520,
"typeArguments": [
{
"type": "reference",
"id": 2486,
"typeArguments": [
{
"type": "reference",
"id": 2844,
"name": "Connection"
}
],
"name": "IDatabaseDriver"
}
],
"name": "Configuration"
}
},
{
"id": 2913,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 1736,
"name": "ConnectionOptions"
}
},
{
"id": 2914,
"name": "type",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "read"
},
{
"type": "literal",
"value": "write"
}
]
},
"defaultValue": "'write'"
}
],
"type": {
"type": "reference",
"id": 2909,
"name": "AbstractSqlConnection"
},
"inheritedFrom": {
"type": "reference",
"id": 2846,
"name": "Connection.constructor"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2845,
"name": "Connection.constructor"
}
},
{
"id": 2918,
"name": "close",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 16,
"character": 8
}
],
"signatures": [
{
"id": 2919,
"name": "close",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Closes the database connection (aka disconnect)"
},
"parameters": [
{
"id": 2920,
"name": "force",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"overwrites": {
"type": "reference",
"id": 2860,
"name": "Connection.close"
}
}
],
"overwrites": {
"type": "reference",
"id": 2859,
"name": "Connection.close"
}
},
{
"id": 2971,
"name": "connect",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/connections/Connection.ts",
"line": 26,
"character": 11
}
],
"signatures": [
{
"id": 2972,
"name": "connect",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Establishes connection to database"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 2856,
"name": "Connection.connect"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2855,
"name": "Connection.connect"
}
},
{
"id": 2931,
"name": "execute",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 33,
"character": 8
}
],
"signatures": [
{
"id": 2932,
"name": "execute",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"typeParameter": [
{
"id": 2933,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 69,
"typeArguments": [
{
"type": "reference",
"id": 71,
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
},
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "symbol"
}
]
}
],
"name": "AnyEntity"
}
],
"name": "EntityData"
},
{
"type": "reference",
"id": 2897,
"name": "QueryResult"
},
{
"type": "array",
"elementType": {
"type": "reference",
"id": 69,
"typeArguments": [
{
"type": "reference",
"id": 71,
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
},
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "symbol"
}
]
}
],
"name": "AnyEntity"
}
],
"name": "EntityData"
}
}
]
},
"default": {
"type": "array",
"elementType": {
"type": "reference",
"id": 69,
"typeArguments": [
{
"type": "reference",
"id": 71,
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
},
{
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
},
{
"type": "intrinsic",
"name": "symbol"
}
]
}
],
"name": "AnyEntity"
}
],
"name": "EntityData"
}
}
}
],
"parameters": [
{
"id": 2934,
"name": "queryOrKnex",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
},
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Knex.QueryBuilder",
"package": "knex",
"name": "QueryBuilder"
},
{
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Knex.Raw",
"package": "knex",
"name": "Raw"
}
]
}
},
{
"id": 2935,
"name": "params",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
},
"defaultValue": "[]"
},
{
"id": 2936,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "all"
},
{
"type": "literal",
"value": "get"
},
{
"type": "literal",
"value": "run"
}
]
},
"defaultValue": "'all'"
},
{
"id": 2937,
"name": "ctx",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 2933,
"name": "T"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"overwrites": {
"type": "reference",
"id": 2873,
"name": "Connection.execute"
}
}
],
"overwrites": {
"type": "reference",
"id": 2872,
"name": "Connection.execute"
}
},
{
"id": 2977,
"name": "getClientUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/Connection.ts",
"line": 61,
"character": 2
}
],
"signatures": [
{
"id": 2978,
"name": "getClientUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 2881,
"name": "Connection.getClientUrl"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2880,
"name": "Connection.getClientUrl"
}
},
{
"id": 2975,
"name": "getConnectionOptions",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/Connection.ts",
"line": 49,
"character": 2
}
],
"signatures": [
{
"id": 2976,
"name": "getConnectionOptions",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"id": 2901,
"name": "ConnectionConfig"
},
"inheritedFrom": {
"type": "reference",
"id": 2879,
"name": "Connection.getConnectionOptions"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2878,
"name": "Connection.getConnectionOptions"
}
},
{
"id": 2973,
"name": "getDefaultClientUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isAbstract": true
},
"sources": [
{
"fileName": "lib/connections/Connection.ts",
"line": 41,
"character": 11
}
],
"signatures": [
{
"id": 2974,
"name": "getDefaultClientUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Returns default client url for given driver (e.g. mongodb://127.0.0.1:27017 for mongodb)"
},
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 2863,
"name": "Connection.getDefaultClientUrl"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2862,
"name": "Connection.getDefaultClientUrl"
}
},
{
"id": 2916,
"name": "getKnex",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 12,
"character": 2
}
],
"signatures": [
{
"id": 2917,
"name": "getKnex",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
],
"qualifiedName": "Knex",
"package": "knex",
"name": "Knex"
}
}
]
},
{
"id": 2921,
"name": "isConnected",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 20,
"character": 8
}
],
"signatures": [
{
"id": 2922,
"name": "isConnected",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Are we connected to the database"
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "boolean"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"overwrites": {
"type": "reference",
"id": 2858,
"name": "Connection.isConnected"
}
}
],
"overwrites": {
"type": "reference",
"id": 2857,
"name": "Connection.isConnected"
}
},
{
"id": 2938,
"name": "loadFile",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 59,
"character": 8
}
],
"signatures": [
{
"id": 2939,
"name": "loadFile",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Execute raw SQL queries from file"
},
"parameters": [
{
"id": 2940,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 2979,
"name": "setMetadata",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/Connection.ts",
"line": 68,
"character": 2
}
],
"signatures": [
{
"id": 2980,
"name": "setMetadata",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 2981,
"name": "metadata",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"name": "MetadataStorage"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
},
"inheritedFrom": {
"type": "reference",
"id": 2883,
"name": "Connection.setMetadata"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2882,
"name": "Connection.setMetadata"
}
},
{
"id": 2923,
"name": "transactional",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 29,
"character": 8
}
],
"signatures": [
{
"id": 2924,
"name": "transactional",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"typeParameter": [
{
"id": 2925,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"parameters": [
{
"id": 2926,
"name": "cb",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 2927,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 2928,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 2929,
"name": "trx",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 2925,
"name": "T"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
},
{
"id": 2930,
"name": "ctx",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 2925,
"name": "T"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"overwrites": {
"type": "reference",
"id": 2865,
"name": "Connection.transactional"
}
}
],
"overwrites": {
"type": "reference",
"id": 2864,
"name": "Connection.transactional"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2910
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
2918,
2971,
2931,
2977,
2975,
2973,
2916,
2921,
2938,
2979,
2923
]
}
],
"sources": [
{
"fileName": "lib/connections/AbstractSqlConnection.ts",
"line": 8,
"character": 22
}
],
"extendedTypes": [
{
"type": "reference",
"id": 2844,
"name": "Connection"
}
]
},
{
"id": 2698,
"name": "AbstractSqlDriver",
"kind": 128,
"kindString": "Class",
"flags": {
"isAbstract": true
},
"children": [
{
"id": 2799,
"name": "aggregate",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/drivers/DatabaseDriver.ts",
"line": 33,
"character": 8
}
],
"signatures": [
{
"id": 2800,
"name": "aggregate",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 2801,
"name": "entityName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2802,
"name": "pipeline",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 2639,
"name": "DatabaseDriver.aggregate"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2638,
"name": "DatabaseDriver.aggregate"
}
},
{
"id": 2815,
"name": "close",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/drivers/DatabaseDriver.ts",
"line": 97,
"character": 8
}
],
"signatures": [
{
"id": 2816,
"name": "close",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 2817,
"name": "force",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "void"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 2670,
"name": "DatabaseDriver.close"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2669,
"name": "DatabaseDriver.close"
}
},
{
"id": 2808,
"name": "connect",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/drivers/DatabaseDriver.ts",
"line": 75,
"character": 8
}
],
"signatures": [
{
"id": 2809,
"name": "connect",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"name": "C"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 2663,
"name": "DatabaseDriver.connect"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 2662,
"name": "DatabaseDriver.connect"
}
},
{
"id": 2723,
"name": "count",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "lib/drivers/AbstractSqlDriver.ts",
"line": 69,
"character": 8
}
],
"signatures": [
{
"id": 2724,
"name": "count",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 2725,
"name": "entityName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 2726,
"name": "where",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 2727,
"name": "ctx",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
},
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Knex.Transaction",
"package": "knex",
"name": "Transaction"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",