Class ConnectionGRPC

Hierarchy (view full)

ConnectionGQL
- ConnectionGRPC

Index

Constructors

Properties

authEnabled grpc host http oidcAuth?

Methods

aggregate batch close delete get getDetails head login patch postEmpty postReturn put query search tenants connect use

Constructors

`Private` constructor

new ConnectionGRPC(params): ConnectionGRPC
Parameters
- params: GrpcConnectionParams & {
  grpcMaxMessageLength: number;
  }
Returns ConnectionGRPC
Overrides ConnectionGQL.constructor
- Defined in connection/grpc.ts:45

Properties

`Protected` authEnabled

authEnabled: boolean

`Private` grpc

grpc: GrpcClient

`Readonly` host

host: string

`Readonly` http

http: HttpClient

`Optional` oidcAuth

oidcAuth?: OidcAuthenticator

Methods

aggregate

aggregate(collection, consistencyLevel?, tenant?): Promise<Aggregate>
Parameters
- collection: string
- Optional consistencyLevel: ConsistencyLevel
- Optional tenant: string
Returns Promise<Aggregate>
- Defined in connection/grpc.ts:111

batch

batch(collection, consistencyLevel?, tenant?): Promise<Batch>
Parameters
- collection: string
- Optional consistencyLevel: ConsistencyLevel
- Optional tenant: string
Returns Promise<Batch>
- Defined in connection/grpc.ts:102

close

close(): void
Returns void
Overrides ConnectionGQL.close
- Defined in connection/grpc.ts:138

delete

delete(path, payload, expectReturnContent?): any
Parameters
- path: string
- payload: any
- expectReturnContent: boolean = false
Returns any
Inherited from ConnectionGQL.delete
- Defined in connection/http.ts:164

get

get<T>(path, expectReturnContent?): Promise<T>
Type Parameters
- T
Parameters
- path: string
- expectReturnContent: boolean = true
Returns Promise<T>
Inherited from ConnectionGQL.get
- Defined in connection/http.ts:178

getDetails

getDetails(): Promise<ConnectionDetails>
Returns Promise<ConnectionDetails>
Inherited from ConnectionGQL.getDetails
- Defined in connection/http.ts:207

head

head(path, payload): any
Parameters
- path: string
- payload: any
Returns any
Inherited from ConnectionGQL.head
- Defined in connection/http.ts:171

login

login(): Promise<string>
Returns Promise<string>
Inherited from ConnectionGQL.login
- Defined in connection/http.ts:185

patch

patch(path, payload): any
Parameters
- path: string
- payload: any
Returns any
Inherited from ConnectionGQL.patch
- Defined in connection/http.ts:157

postEmpty

postEmpty<B>(path, payload): Promise<void>
Type Parameters
- B
Parameters
- path: string
- payload: B
Returns Promise<void>
Inherited from ConnectionGQL.postEmpty
- Defined in connection/http.ts:143

postReturn

postReturn<B, T>(path, payload): Promise<T>
Type Parameters
- B
- T
Parameters
- path: string
- payload: B
Returns Promise<T>
Inherited from ConnectionGQL.postReturn
- Defined in connection/http.ts:136

put

put(path, payload, expectReturnContent?): any
Parameters
- path: string
- payload: any
- expectReturnContent: boolean = true
Returns any
Inherited from ConnectionGQL.put
- Defined in connection/http.ts:150

query

query<V, T>(query, variables?): Promise<{
data: T;
}>
Type Parameters
- V extends Variables
- T = any
Parameters
- query: any
- Optional variables: V
Returns Promise<{
data: T;
}>
Inherited from ConnectionGQL.query
- Defined in connection/gql.ts:12

search

search(collection, consistencyLevel?, tenant?): Promise<Search>
Parameters
- collection: string
- Optional consistencyLevel: ConsistencyLevel
- Optional tenant: string
Returns Promise<Search>
- Defined in connection/grpc.ts:122

tenants

tenants(collection): Promise<Tenants>
Parameters
- collection: string
Returns Promise<Tenants>
- Defined in connection/grpc.ts:131

`Static` `Private` connect

connect(params, grpcMaxLengthPromise): Promise<ConnectionGRPC>
Parameters
- params: GrpcConnectionParams
- grpcMaxLengthPromise: Promise<number>
Returns Promise<ConnectionGRPC>
- Defined in connection/grpc.ts:83

`Static` use

use(params): Promise<{
    connection: ConnectionGRPC;
    dbVersionProvider: DbVersionProvider;
    dbVersionSupport: DbVersionSupport;
}> | {
    connection: ConnectionGRPC;
    dbVersionProvider: DbVersionProvider;
    dbVersionSupport: DbVersionSupport;
}
Parameters
- params: GrpcConnectionParams
Returns Promise<{
    connection: ConnectionGRPC;
    dbVersionProvider: DbVersionProvider;
    dbVersionSupport: DbVersionSupport;
}> | {
    connection: ConnectionGRPC;
    dbVersionProvider: DbVersionProvider;
    dbVersionSupport: DbVersionSupport;
}
- Defined in connection/grpc.ts:50