Struct ydb_unofficial::client::YdbConnection

pub struct YdbConnection<C: Credentials> { /* private fields */ }

Ydb connection implementation, that pass database name and auth data to grpc channel

Implementations

impl YdbConnection<String>

pub fn from_env() -> Self

Creates connection from environment. It uses following env variables

• YDB_URL - grpc-url to database host
• DB_NAME - name of database connect to
• DB_TOKEN - temporary token to access to database

impl<C: Credentials> YdbConnection<C>

pub fn new(channel: Channel, db_name: AsciiValue, creds: C) -> Self

YdbConnection constructor

Arguments

• channel - transport channel to database (can be make from Endpoint)
• db_name - database name (you can get it from yandex cloud for example) in AsciiValue format
• creds - some object, that implements Credentials (e.g. String)

Examples

See self

pub fn discovery(&mut self) -> DiscoveryServiceClient<&mut Self>

Creates discovery service client

Examples

    let mut conn = ydb_unofficial::YdbConnection::from_env();
    let db_name = std::env::var("DB_NAME").unwrap();
    use ydb_unofficial::generated::ydb::discovery::ListEndpointsRequest;
    let endpoints_response = conn.discovery().list_endpoints(
        ListEndpointsRequest{
            database: db_name.into(), 
            ..Default::default()
        }
    ).await.unwrap();
    // how you can parse response to invoke result with YdbResponseWithResult trait
    use ydb_unofficial::YdbResponseWithResult;
    let endpoints_result = endpoints_response.get_ref().result().unwrap();
    assert!(endpoints_result.endpoints.len() > 0);

pub async fn table(&mut self) -> Result<TableClientWithSession<'_, C>, YdbError>

Creates session and returns TableClientWithSession

Examples

    let mut conn = ydb_unofficial::YdbConnection::from_env();
    let mut table_client = conn.table().await.unwrap();
    use ydb_unofficial::generated::ydb::table::*;
    let keep_alive_response = table_client.keep_alive(KeepAliveRequest::default()).await.unwrap();
    //..some another code

pub fn table_if_ready(&mut self) -> Option<TableClientWithSession<'_, C>>

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

Trait Implementations

impl<C: Debug + Credentials> Debug for YdbConnection<C>

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

Formats the value using the given formatter.

impl<C: Credentials> Drop for YdbConnection<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: Credentials> Service<Request<UnsyncBoxBody<Bytes, Status>>> for YdbConnection<C>

type Response = Response<UnsyncBoxBody<Bytes, Status>>

Responses given by the service.

type Error = Error

Errors produced by the service.

type Future = ResponseFuture<ResponseFuture>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, request: Request<BoxBody>) -> Self::Future

Process the request and return the response asynchronously.