Struct RqliteClient

pub struct RqliteClient { /* private fields */ }

A client for interacting with a rqlite cluster.

Implementations

impl RqliteClient

pub async fn fetch<Q>(&self, q: Q) -> Result<Vec<Row>, RequestError>

where Q: TryInto<RqliteQuery>, RequestError: From<Q::Error>,

Executes a query that returns results. Returns a vector of Rows if the query was successful, otherwise an error.

Errors

This function will return an error if:

• The query could not be converted to a RqliteQuery
• The request to the rqlite server failed
• The response could not be parsed
• The database returned an error

pub async fn exec<Q>(&self, q: Q) -> Result<QueryResult, RequestError>

where Q: TryInto<RqliteQuery>, RequestError: From<Q::Error>,

Executes a query that does not return any results. Returns the QueryResult if the query was successful, otherwise an error. Is primarily used for INSERT, UPDATE, DELETE and CREATE queries.

Errors

This function will return an error if:

• The query could not be converted to a RqliteQuery
• The request to the rqlite server failed
• The response could not be parsed
• The database returned an error

pub async fn batch<Q>( &self, qs: Vec<Q>, ) -> Result<Vec<RqliteResult<BatchResult>>, RequestError>

where Q: TryInto<RqliteQuery>, RequestError: From<Q::Error>,

Executes a batch of queries. It allows sending multiple queries in a single request. This can be more efficient and reduces round-trips to the database. Returns a vector of RqliteResults. Each result contains the result of the corresponding query in the batch. If a query fails, the corresponding result will contain an error.

For more information on batch queries, see the rqlite documentation.

Errors

This function will return an error if:

• The query could not be converted to a RqliteQuery
• The request to the rqlite server failed
• The response could not be parsed
• The database returned an error

pub async fn transaction<Q>( &self, qs: Vec<Q>, ) -> Result<Vec<RqliteResult<QueryResult>>, RequestError>

where Q: TryInto<RqliteQuery>, RequestError: From<Q::Error>,

Executes a transaction. A transaction is a set of queries that are executed as a single unit. If any of the queries fail, the entire transaction is rolled back. Returns a vector of RqliteResults.

For more information on transactions, see the rqlite documentation.

Errors

This function will return an error if:

• The query could not be converted to a RqliteQuery
• The request to the rqlite server failed
• The response could not be parsed
• The database returned an error
• The transaction could not be executed

pub async fn queue<Q>(&self, qs: Vec<Q>) -> Result<(), RequestError>

where Q: TryInto<RqliteQuery>, RequestError: From<Q::Error>,

Asynchronously executes multiple queries. This results in much higher write performance.

For more information on queued queries, see the rqlite documentation.

Errors

This function will return an error if:

• The query could not be converted to a RqliteQuery
• The request to the rqlite server failed
• The response could not be parsed
• The database returned an error

pub async fn ready(&self) -> bool

Checks if the rqlite cluster is ready. Returns true if the cluster is ready, otherwise false.

pub async fn nodes(&self) -> Result<Vec<Node>, RequestError>

Retrieves the nodes in the rqlite cluster. Returns a vector of Nodes.

Errors

This function will return an error if:

• The request to the rqlite server failed
• The response could not be parsed

pub async fn leader(&self) -> Result<Option<Node>, RequestError>

Retrieves current the leader of the rqlite cluster. Returns a Node if a leader is found, otherwise None.

Errors

This function will return an error if:

• The request to the rqlite server failed
• The response could not be parsed

pub async fn remove_node(&self, id: &str) -> Result<(), RequestError>

Removes a node from the rqlite cluster.

Errors

This function will return an error if:

• The request body cannot be serialized
• The request to the rqlite server failed
• The response indicates a failure
• The response body cannot be read