Class ConnectionGRPC

Hierarchy (View Summary)

ConnectionGQL
- ConnectionGRPC

Index

Properties

authEnabled grpcMaxMessageLength host http oidcAuth?

Methods

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

Properties

`Protected`authEnabled

authEnabled: boolean

grpcMaxMessageLength

grpcMaxMessageLength: number

`Readonly`host

host: string

`Readonly`http

http: HttpClient

`Optional`oidcAuth

oidcAuth?: OidcAuthenticator

Methods

aggregate

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

batch

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

close

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

delete

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

get

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

getDetails

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

head

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

isWcdOnGcp

isWcdOnGcp(): boolean
Returns boolean
Inherited from ConnectionGQL.isWcdOnGcp
- Defined in connection/http.ts:92

patch

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

postEmpty

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

postReturn

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

put

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

query

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

reconnect

reconnect(): Promise<void>
Returns Promise<void>
- Defined in connection/grpc.ts:87

search

search(
    collection: string,
    consistencyLevel?: ConsistencyLevel,
    tenant?: string,
    abortSignal?: AbortSignal,
): Promise<Search>
Parameters
- collection: string
- OptionalconsistencyLevel: ConsistencyLevel
- Optionaltenant: string
- OptionalabortSignal: AbortSignal
Returns Promise<Search>
- Defined in connection/grpc.ts:136

tenants

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

`Static`use

use(
    params: GrpcConnectionParams,
):
    | 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:54

Class ConnectionGRPC

Hierarchy (View Summary)

Index

Properties

Methods

Properties

ProtectedauthEnabled

grpcMaxMessageLength

Readonlyhost

Readonlyhttp

OptionaloidcAuth

Methods

aggregate

Parameters

Returns Promise<Aggregate>

batch

Parameters

Returns Promise<Batch>

close

Returns void

delete

Parameters

Returns any

get

Type Parameters

Parameters

Returns Promise<T>

getDetails

Returns Promise<ConnectionDetails>

head

Parameters

Returns any

isWcdOnGcp

Returns boolean

login

Returns Promise<string>

patch

Parameters

Returns any

postEmpty

Type Parameters

Parameters

Returns Promise<void>

postReturn

Type Parameters

Parameters

Returns Promise<T>

put

Parameters

Returns any

query

Type Parameters

Parameters

Returns Promise<{ data: T }>

reconnect

Returns Promise<void>

search

Parameters

Returns Promise<Search>

tenants

Parameters

Returns Promise<Tenants>

Staticuse

Parameters

Returns | Promise< { connection: ConnectionGRPC; dbVersionProvider: DbVersionProvider; dbVersionSupport: DbVersionSupport; }, > | { connection: ConnectionGRPC; dbVersionProvider: DbVersionProvider; dbVersionSupport: DbVersionSupport; }

Settings

On This Page

`Protected`authEnabled

`Readonly`host

`Readonly`http

`Optional`oidcAuth

`Static`use

Returns
| Promise<
{
connection: ConnectionGRPC;
dbVersionProvider: DbVersionProvider;
dbVersionSupport: DbVersionSupport;
},
>
| {
connection: ConnectionGRPC;
dbVersionProvider: DbVersionProvider;
dbVersionSupport: DbVersionSupport;
}