flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_dropDatabase

Drops (aka deletes) a Cloud Spanner database.

OnInit
./lib/actions/spanner_projects_instances_databases_dropDatabase.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_getDdl

Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.

OnInit
./lib/actions/spanner_projects_instances_databases_getDdl.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_updateDdl

Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

OnInit
./lib/actions/spanner_projects_instances_databases_updateDdl.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_list

Lists all sessions in a given database.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_list.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_create

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_create.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_operations_delete

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

OnInit
./lib/actions/spanner_projects_instances_operations_delete.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_operations_get

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

OnInit
./lib/actions/spanner_projects_instances_operations_get.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_patch

Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name.

OnInit
./lib/actions/spanner_projects_instances_patch.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_operations_cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

OnInit
./lib/actions/spanner_projects_instances_operations_cancel.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_list

Lists Cloud Spanner databases.

OnInit
./lib/actions/spanner_projects_instances_databases_list.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_create

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

OnInit
./lib/actions/spanner_projects_instances_databases_create.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instanceConfigs_list

Lists the supported instance configurations for a given project.

OnInit
./lib/actions/spanner_projects_instanceConfigs_list.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_list

Lists all instances in the given project.

OnInit
./lib/actions/spanner_projects_instances_list.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_create

Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

OnInit
./lib/actions/spanner_projects_instances_create.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_getIamPolicy

Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource.

OnInit
./lib/actions/spanner_projects_instances_databases_getIamPolicy.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_setIamPolicy

Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource.

OnInit
./lib/actions/spanner_projects_instances_databases_setIamPolicy.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_testIamPermissions

Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.

OnInit
./lib/actions/spanner_projects_instances_databases_testIamPermissions.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_beginTransaction

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_beginTransaction.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_commit

Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_commit.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_executeBatchDml

Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in order, sequentially. ExecuteBatchDmlResponse will contain a ResultSet for each DML statement that has successfully executed. If a statement fails, its error status will be returned as part of the ExecuteBatchDmlResponse. Execution will stop at the first failed statement; the remaining statements will not run. ExecuteBatchDml is expected to return an OK status with a response even if there was an error while processing one of the DML statements. Clients must inspect response.status to determine if there were any errors while processing the request. See more details in ExecuteBatchDmlRequest and ExecuteBatchDmlResponse.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_executeBatchDml.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_executeSql

Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_executeSql.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_executeStreamingSql

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_executeStreamingSql.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_partitionQuery

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_partitionQuery.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_partitionRead

Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_partitionRead.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_read

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_read.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_rollback

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_rollback.js
OnStartup
-
OnClose
-

Attributes

-

spanner_projects_instances_databases_sessions_streamingRead

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

OnInit
./lib/actions/spanner_projects_instances_databases_sessions_streamingRead.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-