Skip to content

postgresql.v1.database

"Database is the Schema for the databases API"

Index

Fields

fn new

new(name)

new returns an instance of Database

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"Specification of the desired Database.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"

fn spec.withAllowConnections

withAllowConnections(allowConnections)

"Maps to the ALLOW_CONNECTIONS parameter of CREATE DATABASE and\nALTER DATABASE. If false then no one can connect to this database."

fn spec.withBuiltinLocale

withBuiltinLocale(builtinLocale)

"Maps to the BUILTIN_LOCALE parameter of CREATE DATABASE. This\nsetting cannot be changed. Specifies the locale name when the\nbuiltin provider is used. This option requires localeProvider to\nbe set to builtin. Available from PostgreSQL 17."

fn spec.withCollationVersion

withCollationVersion(collationVersion)

"Maps to the COLLATION_VERSION parameter of CREATE DATABASE. This\nsetting cannot be changed."

fn spec.withConnectionLimit

withConnectionLimit(connectionLimit)

"Maps to the CONNECTION LIMIT clause of CREATE DATABASE and\nALTER DATABASE. How many concurrent connections can be made to\nthis database. -1 (the default) means no limit."

fn spec.withDatabaseReclaimPolicy

withDatabaseReclaimPolicy(databaseReclaimPolicy)

"The policy for end-of-life maintenance of this database."

fn spec.withEncoding

withEncoding(encoding)

"Maps to the ENCODING parameter of CREATE DATABASE. This setting\ncannot be changed. Character set encoding to use in the database."

fn spec.withEnsure

withEnsure(ensure)

"Ensure the PostgreSQL database is present or absent - defaults to \"present\"."

fn spec.withExtensions

withExtensions(extensions)

"The list of extensions to be managed in the database"

fn spec.withExtensionsMixin

withExtensionsMixin(extensions)

"The list of extensions to be managed in the database"

Note: This function appends passed data to existing values

fn spec.withIcuLocale

withIcuLocale(icuLocale)

"Maps to the ICU_LOCALE parameter of CREATE DATABASE. This\nsetting cannot be changed. Specifies the ICU locale when the ICU\nprovider is used. This option requires localeProvider to be set to\nicu. Available from PostgreSQL 15."

fn spec.withIcuRules

withIcuRules(icuRules)

"Maps to the ICU_RULES parameter of CREATE DATABASE. This setting\ncannot be changed. Specifies additional collation rules to customize\nthe behavior of the default collation. This option requires\nlocaleProvider to be set to icu. Available from PostgreSQL 16."

fn spec.withIsTemplate

withIsTemplate(isTemplate)

"Maps to the IS_TEMPLATE parameter of CREATE DATABASE and ALTER\nDATABASE. If true, this database is considered a template and can\nbe cloned by any user with CREATEDB privileges."

fn spec.withLocale

withLocale(locale)

"Maps to the LOCALE parameter of CREATE DATABASE. This setting\ncannot be changed. Sets the default collation order and character\nclassification in the new database."

fn spec.withLocaleCType

withLocaleCType(localeCType)

"Maps to the LC_CTYPE parameter of CREATE DATABASE. This setting\ncannot be changed."

fn spec.withLocaleCollate

withLocaleCollate(localeCollate)

"Maps to the LC_COLLATE parameter of CREATE DATABASE. This\nsetting cannot be changed."

fn spec.withLocaleProvider

withLocaleProvider(localeProvider)

"Maps to the LOCALE_PROVIDER parameter of CREATE DATABASE. This\nsetting cannot be changed. This option sets the locale provider for\ndatabases created in the new cluster. Available from PostgreSQL 16."

fn spec.withName

withName(name)

"The name of the database to create inside PostgreSQL. This setting cannot be changed."

fn spec.withOwner

withOwner(owner)

"Maps to the OWNER parameter of CREATE DATABASE.\nMaps to the OWNER TO command of ALTER DATABASE.\nThe role name of the user who owns the database inside PostgreSQL."

fn spec.withSchemas

withSchemas(schemas)

"The list of schemas to be managed in the database"

fn spec.withSchemasMixin

withSchemasMixin(schemas)

"The list of schemas to be managed in the database"

Note: This function appends passed data to existing values

fn spec.withTablespace

withTablespace(tablespace)

"Maps to the TABLESPACE parameter of CREATE DATABASE.\nMaps to the SET TABLESPACE command of ALTER DATABASE.\nThe name of the tablespace (in PostgreSQL) that will be associated\nwith the new database. This tablespace will be the default\ntablespace used for objects created in this database."

fn spec.withTemplate

withTemplate(template)

"Maps to the TEMPLATE parameter of CREATE DATABASE. This setting\ncannot be changed. The name of the template from which to create\nthis database."

obj spec.cluster

"The name of the PostgreSQL cluster hosting the database."

fn spec.cluster.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

obj spec.extensions

"The list of extensions to be managed in the database"

fn spec.extensions.withEnsure

withEnsure(ensure)

"Specifies whether an extension/schema should be present or absent in\nthe database. If set to present, the extension/schema will be\ncreated if it does not exist. If set to absent, the\nextension/schema will be removed if it exists."

fn spec.extensions.withName

withName(name)

"Name of the extension/schema"

fn spec.extensions.withSchema

withSchema(schema)

"The name of the schema in which to install the extension's objects,\nin case the extension allows its contents to be relocated. If not\nspecified (default), and the extension's control file does not\nspecify a schema either, the current default object creation schema\nis used."

fn spec.extensions.withVersion

withVersion(version)

"The version of the extension to install. If empty, the operator will\ninstall the default version (whatever is specified in the\nextension's control file)"

obj spec.schemas

"The list of schemas to be managed in the database"

fn spec.schemas.withEnsure

withEnsure(ensure)

"Specifies whether an extension/schema should be present or absent in\nthe database. If set to present, the extension/schema will be\ncreated if it does not exist. If set to absent, the\nextension/schema will be removed if it exists."

fn spec.schemas.withName

withName(name)

"Name of the extension/schema"

fn spec.schemas.withOwner

withOwner(owner)

"The role name of the user who owns the schema inside PostgreSQL.\nIt maps to the AUTHORIZATION parameter of CREATE SCHEMA and the\nOWNER TO command of ALTER SCHEMA."