Google.Cloud.Spanner.Data - Class SpannerCommand (5.0.0-beta04)

Reference documentation and code samples for the Google.Cloud.Spanner.Data class SpannerCommand.

Represents a SQL query or command to execute against a Spanner database. If the command is a SQL query, then CommandText contains the entire SQL statement. Use ExecuteReaderAsync() to obtain results.

If the command is an update, insert or delete command, then CommandText is simply "[operation] [spanner_table]" such as "UPDATE MYTABLE" with the parameter collection containing SpannerParameter instances whose name matches a column in the target table. Use ExecuteNonQueryAsync(CancellationToken) to execute the command.

The command may also be a DDL statement such as CREATE TABLE. Use ExecuteNonQueryAsync(CancellationToken) to execute a DDL statement.

Initializes a new instance of SpannerCommand, using a default command timeout.

Initializes a new instance of SpannerCommand.

Initializes a new instance of SpannerCommand.

Initializes a new instance of SpannerCommand

Gets or sets the text command to run against the data source.

Gets or sets the wait time before terminating the attempt to execute a command and generating an error. Defaults to the timeout from the connection string.

Indicates or specifies how the CommandText property is interpreted.

Gets or sets the DbConnection used by this DbCommand.

Gets the collection of DbParameter objects.

Gets or sets the DbTransaction within which this DbCommand object executes.

Gets or sets a value indicating whether the command object should be visible in a customized interface control.

Specifies which replicas or regions should be used for non-transactional reads or queries. May be null.

Options to be used for creating the ephemeral transaction under which this command will be executed if no explicit or ambient transaction is set. These options will be ignored if an explicit transaction is set on the command via Transaction or an ambient transaction has been started via OpenAsync(SpannerTransactionCreationOptions, SpannerTransactionOptions, CancellationToken) and similar methods. May be null, in which case appropriate defaults will be used when needed.

The keys of the rows that should be read from the target table if the command is Read, or null otherwise.

The maximum amount of time the commit of the implicit transaction associated with this command, if any, may be delayed server side for batching with other commits. The bigger the delay, the better the throughput (QPS), but at the expense of commit latency. If set to Zero, commit batching is disabled. May be null, in which case commits will continue to be batched as they had been before this configuration option was made available to Spanner API consumers. May be set to any value between Zero and 500ms.

The parameters of the SQL statement or command.

The optional partition which this command is restricted to. If set, the command runs only on the data associated with the given partition. Setting this property overrides any values in CommandText and Parameters

The RPC priority to use for this command. The default priority is Unspecified.

Query options to use when running SQL and streaming SQL commands.

The connection to the data source.

The statement tag to send to Cloud Spanner for this command.

Gets or sets how command results are applied to the DataRow when used by the Update method of a DbDataAdapter.

Attempts to cancels the execution of a DbCommand.

Returns a copy of this SpannerCommand.

Creates a new instance of a DbParameter object.

Releases the unmanaged resources used by the Component and optionally releases the managed resources.

Executes the command text against the connection.

Providers should implement this method to provide a non-default implementation for System.Data.Common.DbCommand.ExecuteReader* overloads.
The default implementation invokes the synchronous ExecuteReader() method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteReader will be communicated via the returned Task Exception property.
This method accepts a cancellation token that can be used to request the operation to be cancelled early. Implementations may ignore this request.

Executes a SQL statement against a connection object.

This is the asynchronous version of ExecuteNonQuery(). Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.
The default implementation invokes the synchronous ExecuteNonQuery() method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteNonQuery() will be communicated via the returned Task Exception property.
Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.

Executes this command as a partitioned update. The command must be a generalized DML command; CreateDmlCommand(string, SpannerParameterCollection) for details.

Executes this command as a partitioned update. The command must be a generalized DML command; CreateDmlCommand(string, SpannerParameterCollection) for details.

Sends the command to Cloud Spanner and builds a SpannerDataReader.

Executes the command against the SpannerConnection.

Sends the command to Cloud Spanner and builds a SpannerDataReader.

Sends the command to Cloud Spanner and builds a SpannerDataReader.

Sends the command to Cloud Spanner and builds a SpannerDataReader.

Executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.

This is the asynchronous version of ExecuteScalar(). Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.
The default implementation invokes the synchronous ExecuteScalar() method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteScalar will be communicated via the returned Task Exception property.
Do not invoke other methods and properties of the DbCommand object until the returned Task is complete.

Executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored. The return value is converted to type T if possible. This method is thread safe.

Creates a set of CommandPartition objects that are used to execute a query or read operation in parallel. Each of the returned command partitions are used by CreateCommandWithPartition(CommandPartition, SpannerTransaction) to create a new SpannerCommand that returns a subset of data.

Creates a prepared (or compiled) version of the command on the data source.