Struct SqlClient

Source

pub struct SqlClient { /* private fields */ }

Expand description

A SQL service client.

§Examples

use std::sync::Arc;
use tsubakuro_rust_core::prelude::*;

async fn example(session: &Arc<Session>) -> Result<(), TgError> {
    let client: SqlClient = session.make_client();

    // In Tsurugi, DDL is also executed in a transaction.
    // (DDL and DML must not be executed in the same transaction)
    let transaction = client.start_transaction(&TransactionOption::default()).await?;
    let result = {
        let sql = "
          create table customer (
            c_id bigint primary key,
            c_name varchar(30) not null,
            c_age int
          )
        ";
        let result = client.execute(&transaction, sql).await;
        match result {
           Ok(_) => client.commit(&transaction, &CommitOption::default()).await,
           Err(e) => Err(e)
        }
    };
    transaction.close().await?;
    result?;

    let table_list = client.list_tables().await?;
    let table_metadata = client.get_table_metadata("customer").await?;

    Ok(())
}

Implementations§

Source §

impl SqlClient

Source

pub fn service_message_version() -> String

Get service message version.

Source

pub fn set_default_timeout(&mut self, timeout: Duration)

Set default timeout.

Source

pub fn default_timeout(&self) -> Duration

Get default timeout.

Source §

impl SqlClient

Source

pub async fn list_tables(&self) -> Result<TableList, TgError>

Returns the list of available table names in the database, except system tables.

The table names are each fully qualified (maybe with a schema name). To retrieve more details for the individual tables, you can use Self::get_table_metadata.

§Examples

use tsubakuro_rust_core::prelude::*;

async fn example(client: &SqlClient) -> Result<(), TgError> {
    let table_list = client.list_tables().await?;

    let table_names = table_list.table_names();
    for table_name in table_names {
        println!("{}", table_name);
    }

    Ok(())
}

Source

pub async fn list_tables_for( &self, timeout: Duration, ) -> Result<TableList, TgError>

Returns the list of available table names in the database, except system tables.

The table names are each fully qualified (maybe with a schema name). To retrieve more details for the individual tables, you can use Self::get_table_metadata_for.

Source

pub async fn list_tables_async(&self) -> Result<Job<TableList>, TgError>

Returns the list of available table names in the database, except system tables.

The table names are each fully qualified (maybe with a schema name). To retrieve more details for the individual tables, you can use Self::get_table_metadata_async.

Source

pub async fn get_table_metadata( &self, table_name: &str, ) -> Result<TableMetadata, TgError>

Retrieves metadata for a table.

§Examples

use tsubakuro_rust_core::prelude::*;

async fn example(client: &SqlClient) -> Result<(), TgError> {
    let table_metadata = client.get_table_metadata("customer").await?;
    println!("table name={}", table_metadata.table_name());

    let columns = table_metadata.columns();
    for column in columns {
        println!("column name={}", column.name());
    }

    Ok(())
}

Source

pub async fn get_table_metadata_for( &self, table_name: &str, timeout: Duration, ) -> Result<TableMetadata, TgError>

Retrieves metadata for a table.

Source

pub async fn get_table_metadata_async( &self, table_name: &str, ) -> Result<Job<TableMetadata>, TgError>

Retrieves metadata for a table.

Source

pub async fn prepare( &self, sql: &str, placeholders: Vec<SqlPlaceholder>, ) -> Result<SqlPreparedStatement, TgError>

Prepares a SQL statement.

Note: Should invoke SqlPreparedStatement::close before SqlPreparedStatement::drop to dispose the prepared statement.

§Examples

use tsubakuro_rust_core::prelude::*;

async fn example(client: &SqlClient) -> Result<(), TgError> {
    let sql = "insert into customer values(:id, :name, :age)";
    let placeholders = vec![
        SqlPlaceholder::of::<i64>("id"),
        SqlPlaceholder::of::<String>("name"),
        SqlPlaceholder::of::<i32>("age"),
    ];
    let prepared_statement = client.prepare(sql, placeholders).await?;

    prepared_statement.close().await?;
    Ok(())
}

Source

pub async fn prepare_for( &self, sql: &str, placeholders: Vec<SqlPlaceholder>, timeout: Duration, ) -> Result<SqlPreparedStatement, TgError>

Prepares a SQL statement.

Note: Should invoke SqlPreparedStatement::close before SqlPreparedStatement::drop to dispose the prepared statement.

Source

pub async fn prepare_async( &self, sql: &str, placeholders: Vec<SqlPlaceholder>, ) -> Result<Job<SqlPreparedStatement>, TgError>

Prepares a SQL statement.

Note: Should invoke SqlPreparedStatement::close before SqlPreparedStatement::drop to dispose the prepared statement.

Source