Struct DatastoreClient 

pub struct DatastoreClient { /* private fields */ }

A client for interacting with the datastore service.

Implementations

impl DatastoreClient

pub async fn new(config: DatastoreConfig) -> Result<Self, Error>

Creates a new instance of DatastoreClient.

Arguments

• config - The configuration settings for connecting to the datastore.

pub async fn login( &mut self, request: LoginRequest, ) -> Result<LoginResponse, Error>

Logs in to the datastore service with the provided request.

Arguments

• request - The login request containing the necessary credentials.

Returns

• Ok(LoginResponse) - The response received after a successful login.
• Err(Error) - If the login fails or if an error occurs during the process.

pub async fn batch_create( &mut self, request: BatchCreateRequest, token: &str, ) -> Result<ResponseData, Error>

Creates multiple records in the datastore with the provided request.

Arguments

• request - The batch create request containing the records to be created.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn create( &mut self, request: CreateRequest, token: &str, ) -> Result<ResponseData, Error>

Creates a single record in the datastore with the provided request.

Arguments

• request - The create request containing the record to be created.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn delete( &mut self, request: DeleteRequest, token: &str, ) -> Result<ResponseData, Error>

Deletes a record from the datastore with the provided request.

Arguments

• request - The delete request containing the identifier of the record to be deleted.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn batch_delete( &mut self, request: BatchDeleteRequest, token: &str, ) -> Result<ResponseData, Error>

Deletes multiple records from the datastore with the provided request.

Arguments

• request - The batch delete request containing the identifiers of the records to be deleted.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn update( &mut self, request: UpdateRequest, token: &str, ) -> Result<ResponseData, Error>

Updates a record in the datastore with the provided request.

Arguments

• request - The update request containing the record’s updated data.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn batch_update( &mut self, request: BatchUpdateRequest, token: &str, ) -> Result<ResponseData, Error>

Updates multiple records in the datastore with the provided request.

Arguments

• request - The batch update request containing the updated data for multiple records.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn get_by_filter( &mut self, request: GetByFilterRequest, token: &str, ) -> Result<ResponseData, Error>

Retrieves records from the datastore based on the specified filter.

Arguments

• request - The request containing the filter criteria.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the records that match the filter.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn aggregate( &mut self, request: AggregateRequest, token: &str, ) -> Result<ResponseData, Error>

Performs aggregation on records in the datastore based on the provided request.

Arguments

• request - The aggregation request specifying the criteria for aggregation.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the aggregation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn get_by_id( &mut self, request: GetByIdRequest, token: &str, ) -> Result<ResponseData, Error>

Retrieves a record from the datastore by its identifier.

Arguments

• request - The request containing the identifier of the record to be retrieved.
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the requested record.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn upsert( &mut self, request: UpsertRequest, token: &str, ) -> Result<ResponseData, Error>

Updates (if already present) or creates (if not) a record in the datastore.

Arguments

• request - The request containing the record to be updated or created (based on a list of conflict columns).
• token - The authorization token to authorize the request.

Returns

• Ok(ResponseData) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

pub async fn register_device( &mut self, request: RegisterDeviceRequest, token: &str, ) -> Result<ResponseData, Error>

Registeres a new account

Arguments

• request - The request containing the account info.
• token - The authorization token to authorize the request.

Returns

• Ok(RegisterResponse) - The response data containing the result of the operation.
• Err(Error) - If the operation fails or if an error occurs during the process.

Trait Implementations

impl Clone for DatastoreClient

fn clone(&self) -> DatastoreClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatastoreClient

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

Formats the value using the given formatter.