datastore.datastore

Module Contents

Classes

Datastore

Functions

init_api_root(api_root)

Attributes

SCOPES
log
LookUpResult

datastore.datastore.SCOPES = ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/datastore']

datastore.datastore.log

datastore.datastore.LookUpResult

datastore.datastore.init_api_root(api_root)

Parameters:

api_root (Optional[str]) –

Return type:

Tuple[bool, str]

class datastore.datastore.Datastore(project=None, service_file=None, namespace='', session=None, token=None, api_root=None)

Parameters:

• project (Optional[str]) –

• service_file (Optional[Union[str, IO[AnyStr]]]) –

• namespace (str) –

• session (Optional[requests.Session]) –

• token (Optional[gcloud.aio.auth.Token]) –

• api_root (Optional[str]) –

datastore_operation_kind

entity_result_kind

key_kind

mutation_result_kind

query_result_batch_kind

value_kind

_project: str | None

_api_root: str

_api_is_dev: bool

async project()

Return type:

str

static _make_commit_body(mutations, transaction=None, mode=Mode.TRANSACTIONAL)

Parameters:

• mutations (List[Dict[str, Any]]) –

• transaction (Optional[str]) –

• mode (datastore.constants.Mode) –

Return type:

Dict[str, Any]

async headers()

Return type:

Dict[str, str]

classmethod make_mutation(operation, key, properties=None)

Parameters:

• operation (datastore.constants.Operation) –

• key (datastore.key.Key) –

• properties (Optional[Dict[str, Any]]) –

Return type:

Dict[str, Any]

async allocateIds(keys, session=None, timeout=10)

Parameters:

• keys (List[datastore.key.Key]) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

List[datastore.key.Key]

async beginTransaction(session=None, timeout=10)

Parameters:

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

str

async commit(mutations, transaction=None, mode=Mode.TRANSACTIONAL, session=None, timeout=10)

Parameters:

• mutations (List[Dict[str, Any]]) –

• transaction (Optional[str]) –

• mode (datastore.constants.Mode) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

Dict[str, Any]

async export(output_bucket_prefix, kinds=None, namespaces=None, labels=None, session=None, timeout=10)

Parameters:

• output_bucket_prefix (str) –

• kinds (Optional[List[str]]) –

• namespaces (Optional[List[str]]) –

• labels (Optional[Dict[str, str]]) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

datastore.datastore_operation.DatastoreOperation

async get_datastore_operation(name, session=None, timeout=10)

Parameters:

• name (str) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

datastore.datastore_operation.DatastoreOperation

async lookup(keys, transaction=None, newTransaction=None, consistency=Consistency.STRONG, session=None, timeout=10)

Parameters:

• keys (List[datastore.key.Key]) –

• transaction (Optional[str]) –

• newTransaction (Optional[datastore.transaction_options.TransactionOptions]) –

• consistency (datastore.constants.Consistency) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

LookUpResult

_build_lookup_result(data)

Parameters:

data (Dict[str, Any]) –

Return type:

LookUpResult

_build_read_options(consistency, newTransaction, transaction)

Parameters:

• consistency (datastore.constants.Consistency) –

• newTransaction (Optional[datastore.transaction_options.TransactionOptions]) –

• transaction (Optional[str]) –

Return type:

Dict[str, Any]

async reserveIds(keys, database_id='', session=None, timeout=10)

Parameters:

• keys (List[datastore.key.Key]) –

• database_id (str) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

None

async rollback(transaction, session=None, timeout=10)

Parameters:

• transaction (str) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

None

async runQuery(query, transaction=None, consistency=Consistency.EVENTUAL, session=None, timeout=10)

Parameters:

• query (datastore.query.BaseQuery) –

• transaction (Optional[str]) –

• consistency (datastore.constants.Consistency) –

• session (Optional[requests.Session]) –

• timeout (int) –

Return type:

datastore.query.QueryResultBatch

async delete(key, session=None)

Parameters:

• key (datastore.key.Key) –

• session (Optional[requests.Session]) –

Return type:

Dict[str, Any]

async insert(key, properties, session=None)

Parameters:

• key (datastore.key.Key) –

• properties (Dict[str, Any]) –

• session (Optional[requests.Session]) –

Return type:

Dict[str, Any]

async update(key, properties, session=None)

Parameters:

• key (datastore.key.Key) –

• properties (Dict[str, Any]) –

• session (Optional[requests.Session]) –

Return type:

Dict[str, Any]

async upsert(key, properties, session=None)

Parameters:

• key (datastore.key.Key) –

• properties (Dict[str, Any]) –

• session (Optional[requests.Session]) –

Return type:

Dict[str, Any]

async operate(operation, key, properties=None, session=None)

Parameters:

• operation (datastore.constants.Operation) –

• key (datastore.key.Key) –

• properties (Optional[Dict[str, Any]]) –

• session (Optional[requests.Session]) –

Return type:

Dict[str, Any]

async close()

Return type:

None

async __aenter__()

Return type:

Datastore

async __aexit__(*args)

Parameters:

args (Any) –

Return type:

None