C# Class PhoenixSharp.PhoenixClient

Inheritance: IPhoenixClient

Datei anzeigen Open project: Azure/hdinsight-phoenix-sharp Class Usage Examples

Public Methods

Method	Description
CatalogsRequestAsync ( string connectionId, RequestOptions options ) : Task	This request is used to fetch the available catalog names in the database.
CloseConnectionRequestAsync ( string connectionId, RequestOptions options ) : Task	This request is used to close the Connection object in the Phoenix query server identified by the given IDs.
CloseStatementRequestAsync ( string connectionId, uint statementId, RequestOptions options ) : Task	This request is used to close the Statement object in the Phoenix query server identified by the given IDs.
ColumnsRequestAsync ( string catalog, string schemaPattern, string tableNamePattern, string columnNamePattern, string connectionId, RequestOptions options ) : Task	This request is used to fetch the columns in this database.
CommitRequestAsync ( string connectionId, RequestOptions options ) : Task	This request is used to issue a commit on the Connection in the Phoenix query server identified by the given ID.
ConnectionSyncRequestAsync ( string connectionId, ConnectionProperties props, RequestOptions options ) : Task	This request is used to ensure that the client and server have a consistent view of the database properties.
CreateStatementRequestAsync ( string connectionId, RequestOptions options ) : Task	This request is used to create a new Statement in the Phoenix query server.
ExecuteBatchRequestAsync ( string connectionId, uint statementId, pbc updates, RequestOptions options ) : Task	This request is used to execute a batch of updates against a PreparedStatement.
ExecuteRequestAsync ( StatementHandle statementHandle, pbc parameterValues, ulong firstFrameMaxSize, bool hasParameterValues, RequestOptions options ) : Task	This request is used to execute a PreparedStatement, optionally with values to bind to the parameters in the Statement.
FetchRequestAsync ( string connectionId, uint statementId, ulong offset, int frameMaxSize, RequestOptions options ) : Task	This request is used to fetch a batch of rows from a Statement previously created.
OpenConnectionRequestAsync ( string connectionId, string>.pbc info, RequestOptions options ) : Task	This request is used to open a new Connection in the Phoenix query server.
PhoenixClient ( ClusterCredentials credentials ) : Interfaces	Initializes a new instance of the PhoenixClient class. If the client is used within a VNET or on an on-premise cluster, no cluster credentials required. Pass null in this case.
PrepareAndExecuteBatchRequestAsync ( string connectionId, uint statementId, pbc sqlCommands, RequestOptions options ) : Task	This request is used as short-hand to create a Statement and execute a batch of updates against that Statement.
PrepareAndExecuteRequestAsync ( string connectionId, string sql, uint statementId, long maxRowsTotal, int firstFrameMaxSize, RequestOptions options ) : Task	This request is used as a short-hand for create a Statement and fetching the first batch of results in a single call without any parameter substitution.
PrepareRequestAsync ( string connectionId, string sql, long maxRowsTotal, RequestOptions options ) : Task	This request is used to create create a new Statement with the given query in the Phoenix query server.
RollbackRequestAsync ( string connectionId, RequestOptions options ) : Task	This request is used to issue a rollback on the Connection in the Phoenix query server identified by the given ID.
SchemasRequestAsync ( string catalog, string schemaPattern, string connectionId, RequestOptions options ) : Task	This request is used to fetch the table types available in this database.
TableTypesRequestAsync ( string connectionId, RequestOptions options ) : Task	This request is used to fetch the table types available in this database.
TablesRequestAsync ( string catalog, string schemaPattern, string tableNamePattern, pbc typeList, bool hasTypeList, string connectionId, RequestOptions options ) : Task	This request is used to fetch the tables available in this database filtered by the provided criteria.

Private Methods

Method	Description
ExecuteMethodAsync ( string method, byte request, RequestOptions options ) : Task
PostRequestAsync ( byte request, RequestOptions options ) : Task

Method Details

CatalogsRequestAsync() public method

This request is used to fetch the available catalog names in the database.

public CatalogsRequestAsync ( string connectionId, RequestOptions options ) : Task
connectionId	string
options	RequestOptions
return	Task

CloseConnectionRequestAsync() public method

This request is used to close the Connection object in the Phoenix query server identified by the given IDs.

public CloseConnectionRequestAsync ( string connectionId, RequestOptions options ) : Task
connectionId	string
options	RequestOptions
return	Task

CloseStatementRequestAsync() public method

This request is used to close the Statement object in the Phoenix query server identified by the given IDs.

public CloseStatementRequestAsync ( string connectionId, uint statementId, RequestOptions options ) : Task
connectionId	string
statementId	uint
options	RequestOptions
return	Task

ColumnsRequestAsync() public method

This request is used to fetch the columns in this database.

public ColumnsRequestAsync ( string catalog, string schemaPattern, string tableNamePattern, string columnNamePattern, string connectionId, RequestOptions options ) : Task
catalog	string
schemaPattern	string
tableNamePattern	string
columnNamePattern	string
connectionId	string
options	RequestOptions
return	Task

CommitRequestAsync() public method

This request is used to issue a commit on the Connection in the Phoenix query server identified by the given ID.

public CommitRequestAsync ( string connectionId, RequestOptions options ) : Task
connectionId	string
options	RequestOptions
return	Task

ConnectionSyncRequestAsync() public method

This request is used to ensure that the client and server have a consistent view of the database properties.

public ConnectionSyncRequestAsync ( string connectionId, ConnectionProperties props, RequestOptions options ) : Task
connectionId	string
props	ConnectionProperties
options	RequestOptions
return	Task

CreateStatementRequestAsync() public method

This request is used to create a new Statement in the Phoenix query server.

public CreateStatementRequestAsync ( string connectionId, RequestOptions options ) : Task
connectionId	string
options	RequestOptions
return	Task

ExecuteBatchRequestAsync() public method

This request is used to execute a batch of updates against a PreparedStatement.

public ExecuteBatchRequestAsync ( string connectionId, uint statementId, pbc updates, RequestOptions options ) : Task
connectionId	string
statementId	uint
updates	pbc
options	RequestOptions
return	Task

ExecuteRequestAsync() public method

This request is used to execute a PreparedStatement, optionally with values to bind to the parameters in the Statement.

public ExecuteRequestAsync ( StatementHandle statementHandle, pbc parameterValues, ulong firstFrameMaxSize, bool hasParameterValues, RequestOptions options ) : Task
statementHandle	StatementHandle
parameterValues	pbc
firstFrameMaxSize	ulong
hasParameterValues	bool
options	RequestOptions
return	Task

FetchRequestAsync() public method

This request is used to fetch a batch of rows from a Statement previously created.

public FetchRequestAsync ( string connectionId, uint statementId, ulong offset, int frameMaxSize, RequestOptions options ) : Task
connectionId	string
statementId	uint
offset	ulong
frameMaxSize	int
options	RequestOptions
return	Task

OpenConnectionRequestAsync() public method

This request is used to open a new Connection in the Phoenix query server.

public OpenConnectionRequestAsync ( string connectionId, string>.pbc info, RequestOptions options ) : Task
connectionId	string
info	string>.pbc
options	RequestOptions
return	Task

PhoenixClient() public method

Initializes a new instance of the PhoenixClient class. If the client is used within a VNET or on an on-premise cluster, no cluster credentials required. Pass null in this case.

public PhoenixClient ( ClusterCredentials credentials ) : Interfaces
credentials	ClusterCredentials
return	Interfaces

PrepareAndExecuteBatchRequestAsync() public method

This request is used as short-hand to create a Statement and execute a batch of updates against that Statement.

public PrepareAndExecuteBatchRequestAsync ( string connectionId, uint statementId, pbc sqlCommands, RequestOptions options ) : Task
connectionId	string
statementId	uint
sqlCommands	pbc
options	RequestOptions
return	Task

PrepareAndExecuteRequestAsync() public method

This request is used as a short-hand for create a Statement and fetching the first batch of results in a single call without any parameter substitution.

public PrepareAndExecuteRequestAsync ( string connectionId, string sql, uint statementId, long maxRowsTotal, int firstFrameMaxSize, RequestOptions options ) : Task
connectionId	string
sql	string
statementId	uint
maxRowsTotal	long
firstFrameMaxSize	int
options	RequestOptions
return	Task

PrepareRequestAsync() public method

This request is used to create create a new Statement with the given query in the Phoenix query server.

public PrepareRequestAsync ( string connectionId, string sql, long maxRowsTotal, RequestOptions options ) : Task
connectionId	string
sql	string
maxRowsTotal	long
options	RequestOptions
return	Task

RollbackRequestAsync() public method

This request is used to issue a rollback on the Connection in the Phoenix query server identified by the given ID.

public RollbackRequestAsync ( string connectionId, RequestOptions options ) : Task
connectionId	string
options	RequestOptions
return	Task

SchemasRequestAsync() public method

This request is used to fetch the table types available in this database.

public SchemasRequestAsync ( string catalog, string schemaPattern, string connectionId, RequestOptions options ) : Task
catalog	string
schemaPattern	string
connectionId	string
options	RequestOptions
return	Task

TableTypesRequestAsync() public method

This request is used to fetch the table types available in this database.

public TableTypesRequestAsync ( string connectionId, RequestOptions options ) : Task
connectionId	string
options	RequestOptions
return	Task

TablesRequestAsync() public method

This request is used to fetch the tables available in this database filtered by the provided criteria.

public TablesRequestAsync ( string catalog, string schemaPattern, string tableNamePattern, pbc typeList, bool hasTypeList, string connectionId, RequestOptions options ) : Task
catalog	string
schemaPattern	string
tableNamePattern	string
typeList	pbc
hasTypeList	bool
connectionId	string
options	RequestOptions
return	Task