Struct snowflake_api::SnowflakeApi

pub struct SnowflakeApi { /* private fields */ }

Snowflake API, keeps connection pool and manages session for you

Implementations

impl SnowflakeApi

pub fn new( connection: Arc<Connection>, session: Session, account_identifier: String ) -> Self

Create a new SnowflakeApi object with an existing connection and session.

pub fn with_password_auth( account_identifier: &str, warehouse: Option<&str>, database: Option<&str>, schema: Option<&str>, username: &str, role: Option<&str>, password: &str ) -> Result<Self, SnowflakeApiError>

Initialize object with password auth. Authentication happens on the first request.

pub fn with_certificate_auth( account_identifier: &str, warehouse: Option<&str>, database: Option<&str>, schema: Option<&str>, username: &str, role: Option<&str>, private_key_pem: &str ) -> Result<Self, SnowflakeApiError>

Initialize object with private certificate auth. Authentication happens on the first request.

pub fn from_env() -> Result<Self, SnowflakeApiError>

pub async fn close_session(&mut self) -> Result<(), SnowflakeApiError>

Closes the current session, this is necessary to clean up temporary objects (tables, functions, etc) which are Snowflake session dependent. If another request is made the new session will be initiated.

pub async fn exec(&self, sql: &str) -> Result<QueryResult, SnowflakeApiError>

Execute a single query against API. If statement is PUT, then file will be uploaded to the Snowflake-managed storage

pub async fn exec_raw( &self, sql: &str ) -> Result<RawQueryResult, SnowflakeApiError>

Executes a single query against API. If statement is PUT, then file will be uploaded to the Snowflake-managed storage Returns raw bytes in the Arrow response

pub async fn exec_response( &mut self, sql: &str ) -> Result<ExecResponse, SnowflakeApiError>

Useful for debugging to get the straight query response

pub async fn exec_json(&mut self, sql: &str) -> Result<Value, SnowflakeApiError>

Useful for debugging to get raw JSON response