Database

google.firestore.admin.v1. Database

Represents a Database.

Constructor

new Database(propertiesopt)

Constructs a new Database.

Parameters:
Name Type Attributes Description
properties google.firestore.admin.v1.IDatabase <optional>

Properties to set

Implements:
  • IDatabase

Members

appEngineIntegrationMode

Database appEngineIntegrationMode.

concurrencyMode

Database concurrencyMode.

etag

Database etag.

keyPrefix

Database keyPrefix.

locationId

Database locationId.

name

Database name.

type

Database type.

AppEngineIntegrationMode

AppEngineIntegrationMode enum.

Properties:
Name Type Description
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED string

APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED value

ENABLED string

ENABLED value

DISABLED string

DISABLED value

ConcurrencyMode

ConcurrencyMode enum.

Properties:
Name Type Description
CONCURRENCY_MODE_UNSPECIFIED string

CONCURRENCY_MODE_UNSPECIFIED value

OPTIMISTIC string

OPTIMISTIC value

PESSIMISTIC string

PESSIMISTIC value

OPTIMISTIC_WITH_ENTITY_GROUPS string

OPTIMISTIC_WITH_ENTITY_GROUPS value

DatabaseType

DatabaseType enum.

Properties:
Name Type Description
DATABASE_TYPE_UNSPECIFIED string

DATABASE_TYPE_UNSPECIFIED value

FIRESTORE_NATIVE string

FIRESTORE_NATIVE value

DATASTORE_MODE string

DATASTORE_MODE value

Methods

toJSON() → {Object.<string, *>}

Converts this Database to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) fromObject(object) → {google.firestore.admin.v1.Database}

Creates a Database message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.firestore.admin.v1.Database

Database

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Database

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Database message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.admin.v1.Database

Database

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object