Struct NeonCli 

pub struct NeonCli { /* private fields */ }

Available on crate feature neon only.

The Neon CLI (neon, or neonctl), run with --output json. Signed in the way the CLI is (~/.config/neon, shared with the terminal) or with NEON_API_KEY.

Implementations

impl NeonCli

pub fn new() -> Result<Self, NeonError>

The CLI locate_neon finds; NeonError::NotInstalled when there is none.

pub fn with_program(program: impl Into<PathBuf>) -> Self

The CLI at program.

pub fn program(&self) -> &Path

The program it runs.

Trait Implementations

impl Clone for NeonCli

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 NeonCli

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

Formats the value using the given formatter.

impl NeonControl for NeonCli

fn auth_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Who the CLI is signed in as (an error when it isn’t).

fn branches<'life0, 'life1, 'async_trait>( &'life0 self, project: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<Branch>, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The project’s branches, with their annotations.

fn create_branch<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, spec: &'life2 CreateBranch, ) -> Pin<Box<dyn Future<Output = Result<Branch, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a branch (never printing its credentials).

fn delete_branch<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Delete the branch id.

fn reset_branch<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Reset the branch id to its parent’s current state.

fn connection<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, database: Option<&'life3 str>, pooled: bool, ) -> Pin<Box<dyn Future<Output = Result<Connection, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

The branch’s Postgres connection to database (the default one when None), through the connection pooler when pooled.

fn databases<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The branch’s databases.

fn create_database<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, name: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Create the database name on the branch.

fn functions<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<Function>, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The functions deployed on the branch.

fn storage<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Storage, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The branch’s object storage.

fn buckets<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The branch’s buckets.

fn create_bucket<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, name: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Create the bucket name on the branch.

fn create_credential<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, name: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<StorageCredential, NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Mint a storage credential (read and write) called name on the branch.

fn revoke_credential<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, project: &'life1 str, branch: &'life2 str, token_id: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<(), NeonError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Revoke the credential token_id on the branch.