Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NosqlClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • NosqlClient

Constructors

constructor

  • new NosqlClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): NosqlClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: NosqlWaiter

targetService

targetService: string = "Nosql"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://nosql.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeTableCompartment

close

  • close(): void

createIndex

  • Create a new index on the table identified by tableNameOrId. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateIndex API.

    Parameters

    Returns Promise<CreateIndexResponse>

    CreateIndexResponse

createReplica

  • Add a replica for this table This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateReplica API.

    Parameters

    Returns Promise<CreateReplicaResponse>

    CreateReplicaResponse

createTable

  • Create a new table. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTable API.

    Parameters

    Returns Promise<CreateTableResponse>

    CreateTableResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): NosqlWaiter
  • Creates a new NosqlWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns NosqlWaiter

    The service waiters.

deleteIndex

  • Delete an index from the table identified by tableNameOrId. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteIndex API.

    Parameters

    Returns Promise<DeleteIndexResponse>

    DeleteIndexResponse

deleteReplica

  • Delete the specified replica table in the remote region. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteReplica API.

    Parameters

    Returns Promise<DeleteReplicaResponse>

    DeleteReplicaResponse

deleteRow

  • Delete a single row from the table, by primary key. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRow API.

    Parameters

    Returns Promise<DeleteRowResponse>

    DeleteRowResponse

deleteTable

  • Delete a table by tableNameOrId. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTable API.

    Parameters

    Returns Promise<DeleteTableResponse>

    DeleteTableResponse

deleteWorkRequest

  • Cancel a work request operation with the given ID. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteWorkRequest API.

    Parameters

    Returns Promise<DeleteWorkRequestResponse>

    DeleteWorkRequestResponse

getIndex

  • Get information about a single index. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIndex API.

    Parameters

    Returns Promise<GetIndexResponse>

    GetIndexResponse

getRow

  • Get a single row from the table by primary key. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRow API.

    Parameters

    Returns Promise<GetRowResponse>

    GetRowResponse

getTable

  • Get table info by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTable API.

    Parameters

    Returns Promise<GetTableResponse>

    GetTableResponse

getWaiters

getWorkRequest

  • Get the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listIndexes

  • Get a list of indexes on a table. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIndexes API.

    Parameters

    Returns Promise<ListIndexesResponse>

    ListIndexesResponse

listTableUsage

  • Get table usage info. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTableUsage API.

    Parameters

    Returns Promise<ListTableUsageResponse>

    ListTableUsageResponse

listTables

  • Get a list of tables in a compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTables API.

    Parameters

    Returns Promise<ListTablesResponse>

    ListTablesResponse

listWorkRequestErrors

  • Return a (paginated) list of errors for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Return a (paginated) list of logs for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • List the work requests in a compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

prepareStatement

  • Prepare a SQL statement for use in a query with variable substitution.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PrepareStatement API.

    Parameters

    Returns Promise<PrepareStatementResponse>

    PrepareStatementResponse

query

  • Execute a SQL query. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use Query API.

    Parameters

    Returns Promise<QueryResponse>

    QueryResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

summarizeStatement

  • Check the syntax and return a brief summary of a SQL statement.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeStatement API.

    Parameters

    Returns Promise<SummarizeStatementResponse>

    SummarizeStatementResponse

updateRow

  • Write a single row into the table. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRow API.

    Parameters

    Returns Promise<UpdateRowResponse>

    UpdateRowResponse

updateTable

  • Alter the table identified by tableNameOrId, changing schema, limits, or tags

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTable API.

    Parameters

    Returns Promise<UpdateTableResponse>

    UpdateTableResponse