Struct controller::extensions::types::Extension

pub struct Extension {
    pub name: String,
    pub description: Option<String>,
    pub locations: Vec<ExtensionInstallLocation>,
}

Extension lets you define a list of extensions to enable on the instance. To enable extensions, you must specify the name of the extension and the database, schema, and version to enable it on. If the version is not specified, the latest version will be used. The extension must also be installed on the instance. To install extensions, please refer to the TrunkInstall resource.

This example will enable the pg_stat_statements extension on the Postgres database in the public schema.

apiVersion: coredb.io/v1alpha1
kind: CoreDB
metadata:
  name: test-db
spec:
  extensions:
  - name: pg_stat_statements
    locations:
    - database: postgres
      enabled: true
      schema: public
      version: 1.10.0

Fields

name: String

The name of the extension to enable.

description: Option<String>

A description of the extension. (Optional)

Default: “No description provided”

locations: Vec<ExtensionInstallLocation>

A list of locations (databases) to enabled the extension on.

Trait Implementations

impl Clone for Extension

fn clone(&self) -> Extension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Extension

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

Formats the value using the given formatter.

impl Default for Extension

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Extension

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ExtensionStatus> for Extension

fn from(status: ExtensionStatus) -> Self

Converts to this type from the input type.

impl Hash for Extension

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Extension

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for Extension

fn eq(&self, other: &Extension) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Extension

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for Extension

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for Extension

impl StructuralPartialEq for Extension