Typescript HTTP Driver

Connection

Database

Fields
Name Type Description

name

string

Driver Params

DriverParams

DriverParams: DriverParamsBasic | DriverParamsTranslated

DriverParamsBasic

Fields
Name Type Description

addresses

string

password

string

username

string

DriverParamsTranslated

Fields
Name Type Description

password

string

translatedAddresses

TranslatedAddress

username

string

TransactionOptions

Fields
Name Type Description

schemaLockAcquireTimeoutMillis

number

transactionTimeoutMillis

number

TransactionType

TransactionType: "read" | "write" | "schema"

TranslatedAddress

Fields
Name Type Description

external

string

internal

string

TypeDBHttpDriver

TypeDBHttpDriver

new TypeDBHttpDriver(params: DriverParams): TypeDBHttpDriver
Input parameters
Name Description Type

params

DriverParams

Returns

TypeDBHttpDriver

closeTransaction

closeTransaction(transactionId: string): Promise<ApiResponse>
Input parameters
Name Description Type

transactionId

string

Returns

Promise<ApiResponse>

commitTransaction

commitTransaction(transactionId: string): Promise<ApiResponse>
Input parameters
Name Description Type

transactionId

string

Returns

Promise<ApiResponse>

createDatabase

createDatabase(name: string): Promise<ApiResponse>
Input parameters
Name Description Type

name

string

Returns

Promise<ApiResponse>

createUser

createUser(username: string, password: string): Promise<ApiResponse>
Input parameters
Name Description Type

username

string

password

string

Returns

Promise<ApiResponse>

deleteDatabase

deleteDatabase(name: string): Promise<ApiResponse>
Input parameters
Name Description Type

name

string

Returns

Promise<ApiResponse>

deleteUser

deleteUser(username: string): Promise<ApiResponse>
Input parameters
Name Description Type

username

string

Returns

Promise<ApiResponse>

getCurrentUser

getCurrentUser(): Promise<ApiResponse<User>>
Returns

Promise<ApiResponse<User>>

getDatabase

getDatabase(name: string): Promise<ApiResponse<Database>>
Input parameters
Name Description Type

name

string

Returns

Promise<ApiResponse<Database>>

getDatabaseSchema

getDatabaseSchema(name: string): Promise<ApiResponse<string>>
Input parameters
Name Description Type

name

string

Returns

Promise<ApiResponse<string>>

getDatabaseTypeSchema

getDatabaseTypeSchema(name: string): Promise<ApiResponse<string>>
Input parameters
Name Description Type

name

string

Returns

Promise<ApiResponse<string>>

getDatabases

getDatabases(): Promise<ApiResponse<DatabasesListResponse>>
Returns

Promise<ApiResponse<DatabasesListResponse>>

getUser

getUser(username: string): Promise<ApiResponse<User>>
Input parameters
Name Description Type

username

string

Returns

Promise<ApiResponse<User>>

getUsers

getUsers(): Promise<ApiResponse<UsersListResponse>>
Returns

Promise<ApiResponse<UsersListResponse>>

health

health(): Promise<ApiResponse>
Returns

Promise<ApiResponse>

oneShotQuery

oneShotQuery( query: string, commit: boolean, databaseName: string, transactionType: TransactionType, transactionOptions?: TransactionOptions, queryOptions?: QueryOptions, ): Promise<ApiResponse<QueryResponse>>
Input parameters
Name Description Type

query

string

commit

boolean

databaseName

string

transactionType

TransactionType

transactionOptions

TransactionOptions

queryOptions

QueryOptions

Returns

Promise<ApiResponse<QueryResponse>>

openTransaction

openTransaction( databaseName: string, transactionType: TransactionType, transactionOptions?: TransactionOptions, ): Promise<ApiResponse<TransactionOpenResponse>>
Input parameters
Name Description Type

databaseName

string

transactionType

TransactionType

transactionOptions

TransactionOptions

Returns

Promise<ApiResponse<TransactionOpenResponse>>

query

query( transactionId: string, query: string, queryOptions?: QueryOptions, ): Promise<ApiResponse<QueryResponse>>
Input parameters
Name Description Type

transactionId

string

query

string

queryOptions

QueryOptions

Returns

Promise<ApiResponse<QueryResponse>>

rollbackTransaction

rollbackTransaction(transactionId: string): Promise<ApiResponse>
Input parameters
Name Description Type

transactionId

string

Returns

Promise<ApiResponse>

updateUser

updateUser(username: string, password: string): Promise<ApiResponse>
Input parameters
Name Description Type

username

string

password

string

Returns

Promise<ApiResponse>

version

version(): Promise<ApiResponse<VersionResponse>>
Returns

Promise<ApiResponse<VersionResponse>>

User

Fields
Name Type Description

username

string

Static Functions

isBasicParams

isBasicParams(params: DriverParams): params is DriverParamsBasic
Input parameters
Name Description Type

params

DriverParams

Returns

params is DriverParamsBasic

isTranslatedParams

isTranslatedParams(params: DriverParams): params is DriverParamsTranslated
Input parameters
Name Description Type

params

DriverParams

Returns

params is DriverParamsTranslated

remoteOrigin

remoteOrigin(params: DriverParams): string
Input parameters
Name Description Type

params

DriverParams

Returns

string

Response

Answer

Answer: ConceptRowAnswer | ConceptDocument

AnswerType

AnswerType: "ok" | "conceptRows" | "conceptDocuments"

ApiError

Fields
Name Type Description

code

string

message

string

ApiErrorResponse

Fields
Name Type Description

err

ApiError

status

number

ApiOkResponse<OK_RES>

Fields
Name Type Description

ok

OK_RES

ApiResponse<OK_RES>

ApiResponse: ApiOkResponse<OK_RES> | ApiErrorResponse

ConceptDocumentsQueryResponse

Fields
Name Type Description

answerType

"conceptDocuments"

answers

Object

comment

string

query

QueryStructure

queryType

QueryType

ConceptRow

Fields
Name Type Description

[varName: string]

Concept

ConceptRowAnswer

Fields
Name Type Description

data

ConceptRow

involvedBlocks

number

ConceptRowsQueryResponse

Fields
Name Type Description

answerType

"conceptRows"

answers

ConceptRowAnswer

comment

string

query

QueryStructure

queryType

QueryType

DatabasesListResponse

Fields
Name Type Description

databases

Database

Distribution

Distribution: "TypeDB Cluster" | "TypeDB CE"

OkQueryResponse

Fields
Name Type Description

answerType

"ok"

comment

string

query

QueryStructure

queryType

QueryType

SignInResponse

Fields
Name Type Description

token

string

TransactionOpenResponse

Fields
Name Type Description

transactionId

string

UsersListResponse

Fields
Name Type Description

users

User

VersionResponse

Fields
Name Type Description

distribution

Distribution

version

string

Static Functions

isApiError

isApiError(err: any): err is ApiError
Input parameters
Name Description Type

err

any

Returns

err is ApiError

isApiErrorResponse

isApiErrorResponse(res: ApiResponse): res is ApiErrorResponse
Input parameters
Name Description Type

res

ApiResponse

Returns

res is ApiErrorResponse

isOkResponse

isOkResponse<OK_RES>(res: ApiResponse<OK_RES>): res is ApiOkResponse<OK_RES>
Input parameters
Name Description Type

res

ApiResponse

Returns

res is ApiOkResponse<OK_RES>

Concept

Attribute

Fields
Name Type Description

iid

string

kind

"attribute"

type

AttributeType

value

any

valueType

ValueType

AttributeType

Fields
Name Type Description

kind

"attributeType"

label

string

valueType

ValueType

Concept

Concept: Type | Entity | Relation | Attribute | Value

ConceptDocument

ConceptDocument: Object

EdgeKind

EdgeKind:
 | "isa"
 | "has"
 | "links"
 | "sub"
 | "owns"
 | "relates"
 | "plays"
 | "isaExact"
 | "subExact"
 | "assigned"
 | "argument"

Entity

Fields
Name Type Description

iid

string

kind

"entity"

type

EntityType

EntityType

Fields
Name Type Description

kind

"entityType"

label

string

InstantiableType

InstantiableType: EntityType | RelationType | AttributeType

Relation

Fields
Name Type Description

iid

string

kind

"relation"

type

RelationType

RelationType

Fields
Name Type Description

kind

"relationType"

label

string

RoleType

Fields
Name Type Description

kind

"roleType"

label

string

ThingKind

ThingKind: "entity" | "relation" | "attribute"

Type

Type: InstantiableType | RoleType

TypeKind

TypeKind: "entityType" | "relationType" | "attributeType" | "roleType"

Value

Fields
Name Type Description

kind

"value"

value

any

valueType

ValueType

ValueKind

ValueKind: "value"

ValueType

ValueType:
 | "boolean"
 | "integer"
 | "double"
 | "decimal"
 | "date"
 | "datetime"
 | "datetime-tz"
 | "duration"
 | "string"
 | "struct"

Query Structure

Query Constraints

QueryConstraintAny

QueryConstraintAny:
 | QueryConstraintIsa
 | QueryConstraintIsaExact
 | QueryConstraintHas
 | QueryConstraintLinks
 | QueryConstraintSub
 | QueryConstraintSubExact
 | QueryConstraintOwns
 | QueryConstraintRelates
 | QueryConstraintPlays
 | QueryConstraintExpression
 | QueryConstraintFunction
 | QueryConstraintComparison
 | QueryConstraintIs
 | QueryConstraintIid
 | QueryConstraintKind
 | QueryConstraintValue
 | QueryConstraintLabel

QueryConstraintIsa

Fields
Name Type Description

instance

QueryVertexVariable

tag

"isa"

textSpan

QueryConstraintSpan

type

QueryVertexVariable

QueryConstraintIsaExact

Fields
Name Type Description

instance

QueryVertexVariable

tag

"isa!"

textSpan

QueryConstraintSpan

type

QueryVertexVariable

QueryConstraintHas

Fields
Name Type Description

attribute

QueryVertexVariable

owner

QueryVertexVariable

tag

"has"

textSpan

QueryConstraintSpan

Fields
Name Type Description

player

QueryVertexVariable

relation

QueryVertexVariable

role

QueryVertexVariable

tag

"links"

textSpan

QueryConstraintSpan

QueryConstraintSub

Fields
Name Type Description

subtype

QueryVertexVariable

supertype

QueryVertexVariable

tag

"sub"

textSpan

QueryConstraintSpan

QueryConstraintSubExact

Fields
Name Type Description

subtype

QueryVertexVariable

supertype

QueryVertexVariable

tag

"sub!"

textSpan

QueryConstraintSpan

QueryConstraintOwns

Fields
Name Type Description

attribute

QueryVertexVariable

owner

QueryVertexVariable

tag

"owns"

textSpan

QueryConstraintSpan

QueryConstraintExpression

Fields
Name Type Description

arguments

QueryVertexVariable

assigned

QueryVertexVariable

tag

"expression"

text

string

textSpan

QueryConstraintSpan

QueryConstraintFunction

Fields
Name Type Description

arguments

QueryVertexVariable

assigned

QueryVertexVariable

name

string

tag

"functionCall"

textSpan

QueryConstraintSpan

QueryConstraintComparison

Fields
Name Type Description

comparator

string

lhs

QueryVertexVariable

rhs

QueryVertexVariable

tag

"comparison"

textSpan

QueryConstraintSpan

QueryConstraintIs

Fields
Name Type Description

lhs

QueryVertexVariable

rhs

QueryVertexVariable

tag

"is"

textSpan

QueryConstraintSpan

QueryConstraintIid

Fields
Name Type Description

concept

QueryVertexVariable

iid

string

tag

"iid"

textSpan

QueryConstraintSpan

QueryConstraintKind

Fields
Name Type Description

kind

string

tag

"kind"

textSpan

QueryConstraintSpan

type

QueryVertexVariable

QueryConstraintValue

Fields
Name Type Description

attributeType

QueryVertexVariable

tag

"value"

textSpan

QueryConstraintSpan

valueType

string

QueryConstraintLabel

Fields
Name Type Description

label

string

tag

"label"

textSpan

QueryConstraintSpan

type

QueryVertexVariable

QueryConstraintPlays

Fields
Name Type Description

player

QueryVertexVariable

role

QueryVertexVariable

tag

"plays"

textSpan

QueryConstraintSpan

QueryConstraintRelates

Fields
Name Type Description

relation

QueryVertexVariable

role

QueryVertexVariable

tag

"relates"

textSpan

QueryConstraintSpan

QueryConstraintSpan

Fields
Name Type Description

begin

number

end

number

QueryOptions

Fields
Name Type Description

answerCountLimit

number

includeInstanceTypes

boolean

QueryResponse

QueryResponse:
 | OkQueryResponse
 | ConceptRowsQueryResponse
 | ConceptDocumentsQueryResponse

QueryResponseBase

Fields
Name Type Description

answerType

AnswerType

comment

string

query

QueryStructure

queryType

QueryType

QueryStructure

Fields
Name Type Description

blocks

QueryConstraintAny

outputs

string

variables

string

QueryType

QueryType: "read" | "write" | "schema"

QueryVariableInfo

Fields
Name Type Description

name

string

Query Vertices

QueryVertex

QueryVertex: QueryVertexVariable | QueryVertexLabel | QueryVertexValue

QueryVertexKind

QueryVertexKind: "variable" | "label" | "value"

QueryVertexLabel

Fields
Name Type Description

tag

"label"

type

Type

QueryVertexValue

Fields
Name Type Description

tag

"value"

value

Value

QueryVertexVariable

Fields
Name Type Description

id

string

tag

"variable"

Static Functions

getVariableName

getVariableName( structure: QueryStructure, variable: QueryVertexVariable, ): string
Input parameters
Name Description Type

structure

QueryStructure

variable

QueryVertexVariable

Returns

string