Struct Project 

pub struct Project { /* private fields */ }

Entry point for project resources, bound to one authenticated connection.

Implementations

impl Project

pub async fn location( &self, branch: &str, path: &str, ) -> Result<Location, Error>

Pin the head of branch and resolve the Location at path.

impl Project

pub fn client(&self) -> &Client

The client whose credentials and execution backend this Project uses.

pub fn id(&self) -> &ProjectId

Stable project identifier.

pub async fn branch(&self, name: &str) -> Result<BranchHead, Error>

Pin the current head of a branch, which a Commit can publish onto.

pub async fn create_branch( &self, name: &str, commit_id: ProjectCommitId, ) -> Result<BranchHead, Error>

Create a branch at an existing project commit and pin its head.

pub fn snapshot_at(&self, commit_id: ProjectCommitId) -> Snapshot

Open an exact commit. Its snapshot is read-only: commits publish onto a BranchHead.

pub fn resume_commit(&self, saved: SavedCommit) -> Result<FrozenCommit, Error>

Resume a commit saved with FrozenCommit::save, against its original base and branch.

pub async fn table(&self, branch: &str, path: &str) -> Result<Table, Error>

Pin the branch head and resolve a table to an immutable version.

impl Project

pub async fn get(&self) -> Result<ProjectInfo, Error>

Read current project metadata.

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

Delete this project. Requires project administration permission.

pub fn grants(&self, principal: Option<Principal>) -> List<'_, Grant>

List access grants, optionally restricted to one principal.

pub async fn grant_role( &self, request: GrantRoleRequest, ) -> Result<GrantRoleResponse, Error>

Grant a role to a principal on this project.

pub async fn presentation( &self, key: PresentationKey, ) -> Result<Presentation, Error>

Read shared presentation state at a key.

pub async fn save_presentation( &self, request: SavePresentation, ) -> Result<Presentation, Error>

Save shared presentation state against its expected revision.

impl Project

pub async fn write_table( &self, input: impl IntoArrowStream, ) -> Result<Table, Error>

Write the first version of a new table from input.

The table has no name until Commit::create_table binds it and the commit publishes.

impl Project

pub async fn table_session( &self, default_ref: &str, ) -> Result<TableSession, Error>

Open a table session with a branch or c-prefixed commit as its default ref.

impl Project

pub async fn table_writer(&self, schema: SchemaRef) -> Result<TableWrite, Error>

Begin the first version of a new table with rows of schema.

impl Project

pub async fn submit_task( &self, definition: TaskDefinition, options: Option<TaskOptions>, run: Run, ) -> Result<Option<TaskHandle>, Error>

Submit any Task definition, including kinds no resource method wraps.

Returns None when the overlap policy skipped the submission because an equivalent Task already waits to run.

pub fn task(&self, task_id: Uuid) -> TaskHandle

A handle to a Task this Project already holds. It makes no request.

impl Project

pub async fn create_vector_index( &self, source: &Table, field: &str, options: VectorIndexOptions, ) -> Result<VectorIndex, Error>

Create an unnamed Vector Index over the field column of source.

Creation resolves the column through a zero-row plan for the exact source schema. A commit binds the index name before a branch snapshot can refresh it.

pub async fn vector_index( &self, branch: &str, path: &str, ) -> Result<VectorIndex, Error>

Pin the head of branch and resolve the Vector Index at path.

Trait Implementations

impl Clone for Project

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.