Struct Database

pub struct Database {
    catalog: String,
    schema: String,
    dbname: String,
    timezone: String,
    client: Client,
    ctx: FlightContext,
}

Fields

catalog: String

schema: String

dbname: String

timezone: String

client: Client

ctx: FlightContext

Implementations

impl Database

pub fn new( catalog: impl Into<String>, schema: impl Into<String>, client: Client, ) -> Self

Create database service client using catalog and schema

pub fn new_with_dbname(dbname: impl Into<String>, client: Client) -> Self

Create database service client using dbname.

This API is designed for external usage. dbname is:

• the name of database when using GreptimeDB standalone or cluster
• the name provided by GreptimeCloud or other multi-tenant GreptimeDB environment

pub fn set_catalog(&mut self, catalog: impl Into<String>)

Set the catalog for the database client.

fn catalog_or_default(&self) -> &str

pub fn set_schema(&mut self, schema: impl Into<String>)

Set the schema for the database client.

fn schema_or_default(&self) -> &str

pub fn set_timezone(&mut self, timezone: impl Into<String>)

Set the timezone for the database client.

pub fn set_auth(&mut self, auth: AuthScheme)

Set the auth scheme for the database client.

pub async fn insert(&self, requests: InsertRequests) -> Result<u32>

Make an InsertRequests request to the database.

pub async fn insert_with_hints( &self, requests: InsertRequests, hints: &[(&str, &str)], ) -> Result<u32>

Make an InsertRequests request to the database with hints.

pub async fn row_inserts(&self, requests: RowInsertRequests) -> Result<u32>

Make a RowInsertRequests request to the database.

pub async fn row_inserts_with_hints( &self, requests: RowInsertRequests, hints: &[(&str, &str)], ) -> Result<u32>

Make a RowInsertRequests request to the database with hints.

fn put_hints(metadata: &mut MetadataMap, hints: &[(&str, &str)]) -> Result<()>

pub async fn handle(&self, request: Request) -> Result<u32>

Make a request to the database.

pub async fn handle_with_retry( &self, request: Request, max_retries: u32, hints: &[(&str, &str)], ) -> Result<u32>

Retry if connection fails, max_retries is the max number of retries, so the total wait time is max_retries * GRPC_CONN_TIMEOUT

fn to_rpc_request(&self, request: Request) -> GreptimeRequest

pub async fn sql<S>(&self, sql: S) -> Result<Output>

where S: AsRef<str>,

Executes a SQL query without any hints.

pub async fn sql_with_hint<S>( &self, sql: S, hints: &[(&str, &str)], ) -> Result<Output>

where S: AsRef<str>,

Executes a SQL query with optional hints for query optimization.

pub async fn logical_plan(&self, logical_plan: Vec<u8>) -> Result<Output>

Executes a logical plan directly without SQL parsing.

pub async fn create(&self, expr: CreateTableExpr) -> Result<Output>

Creates a new table using the provided table expression.

pub async fn alter(&self, expr: AlterTableExpr) -> Result<Output>

Alters an existing table using the provided alter expression.

async fn do_get( &self, request: Request, hints: &[(&str, &str)], ) -> Result<Output>

pub async fn do_put( &self, stream: Pin<Box<dyn Stream<Item = FlightData> + Send>>, ) -> Result<Pin<Box<dyn Stream<Item = Result<DoPutResponse>>>>>

Ingest a stream of RecordBatches that belong to a table, using Arrow Flight’s “DoPut” method. The return value is also a stream, produces DoPutResponses.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Database

fn default() -> Database

Returns the “default value” for a type.