dotnet-api

C1.DataConnector.AdoNet.C1CommandBase

C1CommandBase Class

The command base class used by all C1DataConnector.AdoNet providers.

Inheritance

C1CommandBase

C1CommandBase<TCommandImpl>

Implements

Namespace: C1.DataConnector.AdoNet

Assembly: C1.AdoNet.Kintone.dll

Syntax

public abstract class C1CommandBase : DbCommand, IComponent, IDbCommand, IDisposable, IAsyncDisposable

Constructors

Name	Description
C1CommandBase()	The default constructor for creating a new C1CommandBase instance.
C1CommandBase(ILogger)	The constructor for creating a new C1CommandBase instance considering a given logger.

Fields

Name	Description
DataReader	A reference to the instance of the C1DataReader that is currently using this command.

Properties

Name	Description
CanGetNextData	To check whether or not more data can be retrieved from the source as the result of executing this C1CommandBase.
CommandText	Gets or sets the text command to run against the data source.
DbParameterCollection	Get the collection containing all the parameters used by this command
DbTransaction	Gets or sets the transaction within which the command executes. Must be a C1.DataConnector.AdoNet.C1TransactionBase.
Key	A key which uniquely identifies this command.
Logger	The logger where the runtime messages are passed to.
Parameters	The Parameters list of this command.
ReturningTable	The table that is returned when insert/update/delete with returning statement

Methods

Name	Description
Cancel()	Attempts to cancel the execution of this command
CreateDbParameter()	Creates and returns a new instance of the DbParameter class.
Dispose(bool)	Disposes the resources of this command
ExecuteBatchCoreAsync(IList<ISQLStatement>, CancellationToken)	Execute a list of nonquery in Batch.
ExecuteDbDataReader(CommandBehavior)	Executes the command text against the connection.
ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken)	An asynchronous version of method ExecuteDbDataReader(CommandBehavior) that executes the command text against the connection.
ExecuteNonQuery()	Executes an SQL statement against a connection object.
ExecuteNonQueryAsync(CancellationToken)	An asynchronous version of method ExecuteNonQuery() that executes a SQL statement against a connection object.
ExecuteNonQueryCoreAsync(ISQLStatement, CancellationToken, SourceTable)	The abstract core method provided to execute a non-query statement.
ExecutePrimitiveSqlAsync(SelectStatement, CancellationToken, bool)	Execute `select` directly in the server pointed by DbConnection.
ExecuteScalar()	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.
ExecuteScalarAsync(CancellationToken)	An asynchronous version of method ExecuteScalar() that 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.
GetNextResultAsync(CancellationToken)	Requests more rows from the result of the last executed command.
GetRequiredColumnNames(string, IList<AssignExpression>)	Gets the column names used to identify a specific row in an UPDATE or DELETE statement.
Prepare()	Creates a prepared (or compiled) version of the command on the data source.
ShouldRequestAllData(SelectStatement)	Checks whether the rows of the tables referred in the passed `statement` need to be retrieved from the server in full or not.
SupportBatch(IEnumerator<ISQLStatement>)	Checks whether the passed `statements` can or cannot be executed on the server as a batch operation.
SupportColumnExpression(SelectStatement)	Virtual method to check whether or not `selectStatement` can be executed directly on the server used by this command, considering the selected column expressions.
SupportDelete(DeleteStatement)	Virtual method to check whether or not `deleteStatement` can be executed directly on the server pointed by the connection used by this command.
SupportGroupBy(GroupbyClause)	Virtual method to check whether or not `groupby` can be executed directly on the server pointed by the connection used by this command.
SupportInsert(InsertStatement)	Virtual method to check whether or not `insertStatement` can be executed directly on the server pointed by the connection used by this command.
SupportJoin(SelectStatement)	Virtual method to check whether or not `joinStatement` can be executed directly on the server pointed by the connection used by this command.
SupportLimit(SelectStatement)	Virtual method to check whether or not `selectStmt.Limit.Limit` and `selectStmt.Offset.Offset` can be executed directly on the server pointed by the connection used by this command.
SupportOrderBy(IList<OrderbyColumn>)	Checks whether the passed `orderby` can or cannot be executed on the server.
SupportUpdate(UpdateStatement)	Virtual method to check whether or not `updateStatement` can be executed directly on the server pointed by the connection used by this command.
SupportWhere(IExpression)	Virtual method to check whether or not `where` can be executed directly on the server pointed by the connection used by this command.
ValidateStatement(ISQLStatement)	Virtual method to validate if the given statement is supported by the implemented provider.