Skip to main content
Module

x/google_datastore/mod.ts>DatastoreIndexes

A set of APIs that allow interfacing to Google Datastore on GCP from Deno.
kitsonk/google-datastore
Go to Latest
class DatastoreIndexes
import { DatastoreIndexes } from "https://deno.land/x/google_datastore@0.0.14/mod.ts";

Provides the APIs for indexes for Datastore instances. Exported for documentation purposes and should not be instantiated by users.

Constructors

new
DatastoreIndexes(auth: Auth)

Methods

create(index: GoogleDatastoreAdminV1Index): Promise<GoogleLongrunningOperation<GoogleDatastoreAdminV1IndexOutput>>

Creates the specified index.

A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY.

If the index already exists, the call will return an ALREADY_EXISTS status. During index creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create.

Indexes with a single property cannot be created.

delete(indexId: string | { indexId: string; }): Promise<GoogleLongrunningOperation<GoogleDatastoreAdminV1IndexOutput>>

Deletes an existing index.

An index can only be deleted if it is in a READY or ERROR state. On successful execution of the request, the index will be in a DELETING state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.

get(indexId: string | { indexId: string; }): Promise<GoogleDatastoreAdminV1IndexOutput>

Gets an index.

list(options?: ListOptions): Promise<GoogleDatastoreAdminV1ListIndexesResponse>

Lists the indexes that match the specified filters.

Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.