Struct Tenant

pub struct Tenant {
    pub id: TenantId,
    pub db_name: String,
    pub db_secret_name: String,
    pub s3_name: String,
    pub os_index_name: String,
    pub env: String,
    pub event_queue_url: Option<String>,
}

Fields

id: TenantId

Unique ID for the tenant

db_name: String

Name of the tenant database

db_secret_name: String

Name for the AWS secret used for the database user

s3_name: String

Name of the tenant s3 bucket

os_index_name: String

Name of the tenant search index

env: String

Environment for the tenant

event_queue_url: Option<String>

Optional event queue (SQS) to send docbox events to

Implementations

impl Tenant

pub async fn create( db: impl DbExecutor<'_>, create: CreateTenant, ) -> DbResult<Tenant>

Create a new tenant

pub async fn find_by_id( db: impl DbExecutor<'_>, id: TenantId, env: &str, ) -> DbResult<Option<Tenant>>

Find a tenant by id within a specific env

pub async fn find_by_bucket( db: impl DbExecutor<'_>, bucket: &str, ) -> DbResult<Option<Tenant>>

Find a tenant using its S3 bucket

pub async fn find_by_env( db: impl DbExecutor<'_>, env: &str, ) -> DbResult<Vec<Tenant>>

Finds all tenants for the specified environment

pub async fn all(db: impl DbExecutor<'_>) -> DbResult<Vec<Tenant>>

Finds all tenants

pub async fn update_os_index( &mut self, db: impl DbExecutor<'_>, os_index_name: String, ) -> DbResult<()>

Update the open search index for the tenant

pub async fn delete(self, db: impl DbExecutor<'_>) -> DbResult<()>

Deletes the tenant

Trait Implementations

impl Clone for Tenant

fn clone(&self) -> Tenant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tenant

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

Formats the value using the given formatter.

impl<'a, R: Row> FromRow<'a, R> for Tenant

where &'a str: ColumnIndex<R>, TenantId: Decode<'a, R::Database> + Type<R::Database>, String: Decode<'a, R::Database> + Type<R::Database>, Option<String>: Decode<'a, R::Database> + Type<R::Database>,

fn from_row(__row: &'a R) -> Result<Self>

impl Serialize for Tenant

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.