Typescript HTTP Driver
Connection
TransactionOptions
Name | Type | Description |
---|---|---|
|
|
|
|
|
TypeDBHttpDriver
TypeDBHttpDriver
new TypeDBHttpDriver(params: DriverParams): TypeDBHttpDriver
Name | Description | Type |
---|---|---|
|
|
TypeDBHttpDriver
closeTransaction
closeTransaction(transactionId: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse>
commitTransaction
commitTransaction(transactionId: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse>
createDatabase
createDatabase(name: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse>
createUser
createUser(username: string, password: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
|
|
|
Promise<ApiResponse>
deleteDatabase
deleteDatabase(name: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse>
deleteUser
deleteUser(username: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse>
getDatabase
getDatabase(name: string): Promise<ApiResponse<Database>>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse<Database>>
getDatabaseSchema
getDatabaseSchema(name: string): Promise<ApiResponse<string>>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse<string>>
getDatabaseTypeSchema
getDatabaseTypeSchema(name: string): Promise<ApiResponse<string>>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse<string>>
getDatabases
getDatabases(): Promise<ApiResponse<DatabasesListResponse>>
Promise<ApiResponse<DatabasesListResponse>>
getUser
getUser(username: string): Promise<ApiResponse<User>>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse<User>>
getUsers
getUsers(): Promise<ApiResponse<UsersListResponse>>
Promise<ApiResponse<UsersListResponse>>
oneShotQuery
oneShotQuery( query: string, commit: boolean, databaseName: string, transactionType: TransactionType, transactionOptions?: TransactionOptions, queryOptions?: QueryOptions, ): Promise<ApiResponse<QueryResponse>>
Name | Description | Type |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Promise<ApiResponse<QueryResponse>>
openTransaction
openTransaction( databaseName: string, transactionType: TransactionType, transactionOptions?: TransactionOptions, ): Promise<ApiResponse<TransactionOpenResponse>>
Name | Description | Type |
---|---|---|
|
|
|
|
|
|
|
|
Promise<ApiResponse<TransactionOpenResponse>>
query
query( transactionId: string, query: string, queryOptions?: QueryOptions, ): Promise<ApiResponse<QueryResponse>>
Name | Description | Type |
---|---|---|
|
|
|
|
|
|
|
|
Promise<ApiResponse<QueryResponse>>
rollbackTransaction
rollbackTransaction(transactionId: string): Promise<ApiResponse>
Name | Description | Type |
---|---|---|
|
|
Promise<ApiResponse>
Static Functions
isBasicParams
isBasicParams(params: DriverParams): params is DriverParamsBasic
Name | Description | Type |
---|---|---|
|
|
params is DriverParamsBasic
Response
ConceptDocumentsQueryResponse
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ConceptRowsQueryResponse
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
OkQueryResponse
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Static Functions
isApiError
isApiError(err: any): err is ApiError
Name | Description | Type |
---|---|---|
|
|
err is ApiError
Concept
Query Structure
Query Constraints
QueryConstraintAny
QueryConstraintAny:
| QueryConstraintIsa
| QueryConstraintIsaExact
| QueryConstraintHas
| QueryConstraintLinks
| QueryConstraintSub
| QueryConstraintSubExact
| QueryConstraintOwns
| QueryConstraintRelates
| QueryConstraintPlays
| QueryConstraintExpression
| QueryConstraintFunction
| QueryConstraintComparison
| QueryConstraintIs
| QueryConstraintIid
| QueryConstraintKind
| QueryConstraintValue
| QueryConstraintLabel
QueryConstraintIsa
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintIsaExact
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintHas
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintLinks
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintSub
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintSubExact
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintOwns
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintExpression
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintFunction
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintComparison
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintIs
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintIid
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintKind
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintValue
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintLabel
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryConstraintPlays
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryResponse
QueryResponse:
| OkQueryResponse
| ConceptRowsQueryResponse
| ConceptDocumentsQueryResponse
QueryResponseBase
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
QueryStructure
Name | Type | Description |
---|---|---|
|
|
|
|
|
|
|
|