Struct Client 

pub struct Client { /* private fields */ }

A shared Spiral connection with one transport and credential provider.

Implementations

impl Client

pub fn application(&self, id: impl Into<String>) -> ApplicationRegistration

Select an application registration for management, without a request.

pub fn installation(&self, id: impl Into<String>) -> InstallationRegistration

Select an organization installation for management, without a request.

impl Client

pub fn builder() -> ClientBuilder

Configure the control-plane endpoints and the scandal that runs Table operations.

pub async fn from_env() -> Result<Self, Error>

The default endpoints and the noninteractive default credential chain.

pub fn from_config(config: &Config) -> Result<Self, Error>

Share a resolved configuration’s HTTP pool and credential provider.

pub fn http(&self) -> &HttpClient

Shared authenticated transport for HTTP operations without a typed SDK client.

pub async fn access_token(&self) -> Result<Token, Error>

Resolve the current credential without changing the selected identity.

pub fn projects(&self) -> &ProjectClient

Project lifecycle and shared presentation state.

pub fn authorization(&self) -> &AuthorizationClient

Access grants and role management through the shared authenticated connection.

pub fn organization(&self) -> &Organization

Organizations, memberships, users, invitations and settings.

pub fn organization_admin(&self) -> &OrganizationAdminClient

Platform administration of organization synchronization and lifecycle.

pub fn workloads(&self) -> &WorkloadClient

Workload identities, public keys and trust policies.

pub fn applications(&self) -> ApplicationsClient

Application registrations, scopes and organization app-access policy.

pub fn installations(&self) -> InstallationsClient

Organization application installations and their approval lifecycle.

pub fn tables(&self) -> &ArborClient

Low-level table resource client for tools and integrations.

pub fn catalog(&self) -> &CatalogClient

Project catalog client.

pub fn locations(&self) -> &HttpLocationClient

Location resource client.

pub fn connections(&self) -> &HttpExternalConnectionClient

Connection service client for credentials, metadata and connectivity checks.

pub fn tasks(&self) -> &HttpTaskClient

Task resource client.

pub fn vector_indexes(&self) -> &HttpVectorIndexClient

Vector-index resource client.

pub async fn functions(&self) -> Result<Functions, Error>

The SPQL functions of the scandal that runs this client’s Table operations.

pub fn table_by_id(&self, resource_id: Uuid, version_id: Uuid) -> Table

Open an exact table version by IDs for tools and integrations.

impl Client

pub fn local(scandal: Arc<dyn Scandal>) -> Result<Self, Error>

A client without a control plane, for Tables in local file:// directories.

scandal must read local files, such as a NativeScandal whose configuration enables local_files. Resource clients and path resolution fail: no API endpoint is configured.

pub fn local_table( &self, root: &Url, identity: TableIdentity, ) -> Result<Table, Error>

The exact version identity of the Table stored in the local directory root, a file:// URL ending in /. Any client with a scandal that reads local files can open one; no control-plane request is made.

pub fn create_local_table( &self, root: &Url, schema: SchemaRef, ) -> Result<LocalTableWrite, Error>

Begin the first version of a new Table in the local directory root, which holds only this Table, with rows of schema.

impl Client

pub fn project(&self, id: impl AsRef<str>) -> Result<Project, Error>

Select a project without making a network request.

impl Client

pub async fn register_prepared( &self, receipt: PreparedWriteReceipt, ) -> Result<Table, Error>

Retry resource registration without replaying a consumed Arrow upload.

The receipt must come from this project’s authorized scandal write. Registration alone does not publish a table in Catalog.

impl Client

pub fn workload(&self, id: impl Into<WorkloadId>) -> Workload

Select a workload without making a network request.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.