Struct fluvio::FluvioAdmin

pub struct FluvioAdmin { /* private fields */ }

An interface for managing a Fluvio cluster

Most applications will not require administrator functionality. The FluvioAdmin interface is used to create, edit, and manage Topics and other operational items. Think of the difference between regular clients of a Database and its administrators. Regular clients may be applications which are reading and writing data to and from tables that exist in the database. Database administrators would be the ones actually creating, editing, or deleting tables. The same thing goes for Fluvio administrators.

If you are writing an application whose purpose is to manage a Fluvio cluster for you, you can gain access to the FluvioAdmin client via the regular Fluvio client, or through the connect or connect_with_config functions.

Example

Note that this may fail if you are not authorized as a Fluvio administrator for the cluster you are connected to.

let admin = fluvio.admin().await;

Implementations

impl FluvioAdmin

pub async fn connect() -> Result<Self>

Creates a new admin connection using the current profile from ~/.fluvio/config

This will attempt to read a Fluvio cluster configuration from your ~/.fluvio/config file, or create one with default settings if you don’t have one. If you want to specify a configuration, see connect_with_config instead.

The admin interface requires you to have administrator privileges on the cluster which you are connecting to. If you don’t have the appropriate privileges, this connection will fail.

Example

let admin = FluvioAdmin::connect().await?;

pub async fn connect_with_config(config: &FluvioConfig) -> Result<Self>

Creates a new admin connection using custom configurations

The admin interface requires you to have administrator privileges on the cluster which you are connecting to. If you don’t have the appropriate privileges, this connection will fail.

Example

use fluvio::config::ConfigFile;
let config_file = ConfigFile::load_default_or_new()?;
let fluvio_config = config_file.config().current_cluster().unwrap();
let admin = FluvioAdmin::connect_with_config(fluvio_config).await?;

pub async fn create<S>( &self, name: String, dry_run: bool, spec: S ) -> Result<()>

where S: CreatableAdminSpec + Sync + Send,

Create new object

pub async fn create_with_config<S>( &self, config: CommonCreateRequest, spec: S ) -> Result<()>

where S: CreatableAdminSpec + Sync + Send,

pub async fn delete<S>(&self, key: impl Into<S::DeleteKey>) -> Result<()>

where S: DeletableAdminSpec + Sync + Send,

Delete object by key key is dependent on spec, most are string but some allow multiple types

For example, to delete a topic:

use fluvio::Fluvio;
use fluvio::metadata::topic::TopicSpec;

async fn delete_topic(name: String) -> anyhow::Result<()> {
    let fluvio = Fluvio::connect().await?;
    let admin = fluvio.admin().await;
    admin.delete::<TopicSpec>(name).await?;
    Ok(())
}

pub async fn force_delete<S>(&self, key: impl Into<S::DeleteKey>) -> Result<()>

where S: DeletableAdminSpec + Sync + Send,

Forcibly delete object by key key is dependent on spec, most are string but some allow multiple types.

This method allows to delete objects marked as ‘system’.

For example, to delete a system topic:

use fluvio::Fluvio;
use fluvio::metadata::topic::TopicSpec;

async fn delete_system_topic(name: String) -> anyhow::Result<()> {
    let fluvio = Fluvio::connect().await?;
    let admin = fluvio.admin().await;
    admin.force_delete::<TopicSpec>(name).await?;
    Ok(())
}

pub async fn all<S>(&self) -> Result<Vec<Metadata<S>>>

where S: AdminSpec, S::Status: Encoder + Decoder + Debug,

return all instance of this spec

pub async fn list<S, F>(&self, filters: Vec<F>) -> Result<Vec<Metadata<S>>>

where S: AdminSpec, ListFilter: From<F>, S::Status: Encoder + Decoder + Debug,

return all instance of this spec by filter

pub async fn list_with_params<S, F>( &self, filters: Vec<F>, summary: bool ) -> Result<Vec<Metadata<S>>>

where S: AdminSpec, ListFilter: From<F>, S::Status: Encoder + Decoder + Debug,

pub async fn list_with_config<S, F>( &self, config: ListRequest<S> ) -> Result<Vec<Metadata<S>>>

where S: AdminSpec, ListFilter: From<F>, S::Status: Encoder + Decoder + Debug,

pub async fn watch<S>( &self ) -> Result<impl Stream<Item = Result<WatchResponse<S>, IoError>>>

where S: AdminSpec, S::Status: Encoder + Decoder,

Watch stream of changes for metadata There is caching, this is just pass through