Skip to content

aiven.v1alpha1.postgreSQL

"PostgreSQL is the Schema for the postgresql API"

Index

Fields

fn new

new(name)

new returns an instance of PostgreSQL

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

"PostgreSQLSpec defines the desired state of postgres instance"

fn spec.withCloudName

withCloudName(cloudName)

"Cloud the service runs in."

fn spec.withDisk_space

withDisk_space(disk_space)

"The disk space of the service, possible values depend on the service type, the cloud provider and the project. Reducing will result in the service re-balancing."

fn spec.withMaintenanceWindowDow

withMaintenanceWindowDow(maintenanceWindowDow)

"Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc."

fn spec.withMaintenanceWindowTime

withMaintenanceWindowTime(maintenanceWindowTime)

"Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format."

fn spec.withPlan

withPlan(plan)

"Subscription plan."

fn spec.withProject

withProject(project)

"Target project."

fn spec.withProjectVpcId

withProjectVpcId(projectVpcId)

"Identifier of the VPC the service should be in, if any."

fn spec.withTerminationProtection

withTerminationProtection(terminationProtection)

"Prevent service from being deleted. It is recommended to have this enabled for all services."

obj spec.authSecretRef

"Authentication reference to Aiven token in a secret"

fn spec.authSecretRef.withKey

withKey(key)

fn spec.authSecretRef.withName

withName(name)

obj spec.connInfoSecretTarget

"Information regarding secret creation"

fn spec.connInfoSecretTarget.withName

withName(name)

"Name of the Secret resource to be created"

obj spec.userConfig

"PostgreSQL specific user configuration options"

fn spec.userConfig.withAdmin_password

withAdmin_password(admin_password)

"Custom password for admin user. Defaults to random string. This must be set only when a new service is being created."

fn spec.userConfig.withAdmin_username

withAdmin_username(admin_username)

"Custom username for admin user. This must be set only when a new service is being created."

fn spec.userConfig.withBackup_hour

withBackup_hour(backup_hour)

"The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed."

fn spec.userConfig.withBackup_minute

withBackup_minute(backup_minute)

"The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed."

fn spec.userConfig.withIp_filter

withIp_filter(ip_filter)

"IP filter Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'"

fn spec.userConfig.withIp_filterMixin

withIp_filterMixin(ip_filter)

"IP filter Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'"

Note: This function appends passed data to existing values

fn spec.userConfig.withPg_service_to_fork_from

withPg_service_to_fork_from(pg_service_to_fork_from)

"Name of the PostgreSQL Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created."

fn spec.userConfig.withPg_version

withPg_version(pg_version)

"PostgreSQL major version"

fn spec.userConfig.withRecovery_target_time

withRecovery_target_time(recovery_target_time)

"Recovery target time when forking a service. This has effect only when a new service is being created."

fn spec.userConfig.withService_to_fork_from

withService_to_fork_from(service_to_fork_from)

"Name of another service to fork from. This has effect only when a new service is being created."

fn spec.userConfig.withShared_buffers_percentage

withShared_buffers_percentage(shared_buffers_percentage)

"shared_buffers_percentage Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. The absolute maximum is 12 GB."

fn spec.userConfig.withSynchronous_replication

withSynchronous_replication(synchronous_replication)

"Synchronous replication type. Note that the service plan also needs to support synchronous replication."

fn spec.userConfig.withVariant

withVariant(variant)

"Variant of the PostgreSQL service, may affect the features that are exposed by default"

fn spec.userConfig.withWork_mem

withWork_mem(work_mem)

"work_mem Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB)."

obj spec.userConfig.migration

"Migrate data from existing server"

fn spec.userConfig.migration.withDbname

withDbname(dbname)

"Database name for bootstrapping the initial connection"

fn spec.userConfig.migration.withHost

withHost(host)

"Hostname or IP address of the server where to migrate data from"

fn spec.userConfig.migration.withPassword

withPassword(password)

"Password for authentication with the server where to migrate data from"

fn spec.userConfig.migration.withPort

withPort(port)

"Port number of the server where to migrate data from"

fn spec.userConfig.migration.withSsl

withSsl(ssl)

"The server where to migrate data from is secured with SSL"

fn spec.userConfig.migration.withUsername

withUsername(username)

"User name for authentication with the server where to migrate data from"

obj spec.userConfig.pg

"postgresql.conf configuration values"

fn spec.userConfig.pg.withAutovacuum_analyze_scale_factor

withAutovacuum_analyze_scale_factor(autovacuum_analyze_scale_factor)

"autovacuum_analyze_scale_factor Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size)"

fn spec.userConfig.pg.withAutovacuum_analyze_threshold

withAutovacuum_analyze_threshold(autovacuum_analyze_threshold)

"autovacuum_analyze_threshold Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples."

fn spec.userConfig.pg.withAutovacuum_freeze_max_age

withAutovacuum_freeze_max_age(autovacuum_freeze_max_age)

"autovacuum_freeze_max_age Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted."

fn spec.userConfig.pg.withAutovacuum_max_workers

withAutovacuum_max_workers(autovacuum_max_workers)

"autovacuum_max_workers Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start."

fn spec.userConfig.pg.withAutovacuum_naptime

withAutovacuum_naptime(autovacuum_naptime)

"autovacuum_naptime Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute"

fn spec.userConfig.pg.withAutovacuum_vacuum_cost_delay

withAutovacuum_vacuum_cost_delay(autovacuum_vacuum_cost_delay)

"autovacuum_vacuum_cost_delay Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds"

fn spec.userConfig.pg.withAutovacuum_vacuum_cost_limit

withAutovacuum_vacuum_cost_limit(autovacuum_vacuum_cost_limit)

"autovacuum_vacuum_cost_limit Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used."

fn spec.userConfig.pg.withAutovacuum_vacuum_scale_factor

withAutovacuum_vacuum_scale_factor(autovacuum_vacuum_scale_factor)

"autovacuum_vacuum_scale_factor Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size)"

fn spec.userConfig.pg.withAutovacuum_vacuum_threshold

withAutovacuum_vacuum_threshold(autovacuum_vacuum_threshold)

"autovacuum_vacuum_threshold Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples"

fn spec.userConfig.pg.withDeadlock_timeout

withDeadlock_timeout(deadlock_timeout)

"deadlock_timeout This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition."

fn spec.userConfig.pg.withIdle_in_transaction_session_timeout

withIdle_in_transaction_session_timeout(idle_in_transaction_session_timeout)

"idle_in_transaction_session_timeout Time out sessions with open transactions after this number of milliseconds"

fn spec.userConfig.pg.withJit

withJit(jit)

"jit Controls system-wide use of Just-in-Time Compilation (JIT)."

fn spec.userConfig.pg.withLog_autovacuum_min_duration

withLog_autovacuum_min_duration(log_autovacuum_min_duration)

"log_autovacuum_min_duration Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions."

fn spec.userConfig.pg.withLog_error_verbosity

withLog_error_verbosity(log_error_verbosity)

"log_error_verbosity Controls the amount of detail written in the server log for each message that is logged."

fn spec.userConfig.pg.withLog_min_duration_statement

withLog_min_duration_statement(log_min_duration_statement)

"log_min_duration_statement Log statements that take more than this number of milliseconds to run, -1 disables"

fn spec.userConfig.pg.withMax_files_per_process

withMax_files_per_process(max_files_per_process)

"max_files_per_process PostgreSQL maximum number of files that can be open per process"

fn spec.userConfig.pg.withMax_locks_per_transaction

withMax_locks_per_transaction(max_locks_per_transaction)

"max_locks_per_transaction PostgreSQL maximum locks per transaction"

fn spec.userConfig.pg.withMax_logical_replication_workers

withMax_logical_replication_workers(max_logical_replication_workers)

"max_logical_replication_workers PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers)"

fn spec.userConfig.pg.withMax_parallel_workers

withMax_parallel_workers(max_parallel_workers)

"max_parallel_workers Sets the maximum number of workers that the system can support for parallel queries"

fn spec.userConfig.pg.withMax_parallel_workers_per_gather

withMax_parallel_workers_per_gather(max_parallel_workers_per_gather)

"max_parallel_workers_per_gather Sets the maximum number of workers that can be started by a single Gather or Gather Merge node"

fn spec.userConfig.pg.withMax_pred_locks_per_transaction

withMax_pred_locks_per_transaction(max_pred_locks_per_transaction)

"max_pred_locks_per_transaction PostgreSQL maximum predicate locks per transaction"

fn spec.userConfig.pg.withMax_prepared_transactions

withMax_prepared_transactions(max_prepared_transactions)

"max_prepared_transactions PostgreSQL maximum prepared transactions"

fn spec.userConfig.pg.withMax_replication_slots

withMax_replication_slots(max_replication_slots)

"max_replication_slots PostgreSQL maximum replication slots"

fn spec.userConfig.pg.withMax_stack_depth

withMax_stack_depth(max_stack_depth)

"max_stack_depth Maximum depth of the stack in bytes"

fn spec.userConfig.pg.withMax_standby_archive_delay

withMax_standby_archive_delay(max_standby_archive_delay)

"max_standby_archive_delay Max standby archive delay in milliseconds"

fn spec.userConfig.pg.withMax_standby_streaming_delay

withMax_standby_streaming_delay(max_standby_streaming_delay)

"max_standby_streaming_delay Max standby streaming delay in milliseconds"

fn spec.userConfig.pg.withMax_wal_senders

withMax_wal_senders(max_wal_senders)

"max_wal_senders PostgreSQL maximum WAL senders"

fn spec.userConfig.pg.withMax_worker_processes

withMax_worker_processes(max_worker_processes)

"max_worker_processes Sets the maximum number of background processes that the system can support"

fn spec.userConfig.pg.withPg_partman_bgw_interval

withPg_partman_bgw_interval(pg_partman_bgw_interval)

"pg_partman_bgw.interval Sets the time interval to run pg_partman's scheduled tasks"

fn spec.userConfig.pg.withPg_partman_bgw_role

withPg_partman_bgw_role(pg_partman_bgw_role)

"pg_partman_bgw.role Controls which role to use for pg_partman's scheduled background tasks."

fn spec.userConfig.pg.withPg_stat_statements_track

withPg_stat_statements_track(pg_stat_statements_track)

"pg_stat_statements.track Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top."

fn spec.userConfig.pg.withTemp_file_limit

withTemp_file_limit(temp_file_limit)

"temp_file_limit PostgreSQL temporary file limit in KiB, -1 for unlimited"

fn spec.userConfig.pg.withTimezone

withTimezone(timezone)

"timezone PostgreSQL service timezone"

fn spec.userConfig.pg.withTrack_activity_query_size

withTrack_activity_query_size(track_activity_query_size)

"track_activity_query_size Specifies the number of bytes reserved to track the currently executing command for each active session."

fn spec.userConfig.pg.withTrack_commit_timestamp

withTrack_commit_timestamp(track_commit_timestamp)

"track_commit_timestamp Record commit time of transactions."

fn spec.userConfig.pg.withTrack_functions

withTrack_functions(track_functions)

"track_functions Enables tracking of function call counts and time used."

fn spec.userConfig.pg.withWal_sender_timeout

withWal_sender_timeout(wal_sender_timeout)

"wal_sender_timeout Terminate replication connections that are inactive for longer than this amount of time, in milliseconds."

fn spec.userConfig.pg.withWal_writer_delay

withWal_writer_delay(wal_writer_delay)

"wal_writer_delay WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance"

obj spec.userConfig.pgbouncer

"PGBouncer connection pooling settings"

fn spec.userConfig.pgbouncer.withIgnore_startup_parameters

withIgnore_startup_parameters(ignore_startup_parameters)

"List of parameters to ignore when given in startup packet"

fn spec.userConfig.pgbouncer.withIgnore_startup_parametersMixin

withIgnore_startup_parametersMixin(ignore_startup_parameters)

"List of parameters to ignore when given in startup packet"

Note: This function appends passed data to existing values

fn spec.userConfig.pgbouncer.withServer_reset_query_always

withServer_reset_query_always(server_reset_query_always)

"Run server_reset_query (DISCARD ALL) in all pooling modes"

obj spec.userConfig.pglookout

"PGLookout settings"

fn spec.userConfig.pglookout.withMax_failover_replication_time_lag

withMax_failover_replication_time_lag(max_failover_replication_time_lag)

"max_failover_replication_time_lag Number of seconds of master unavailability before triggering database failover to standby"

obj spec.userConfig.private_access

"Allow access to selected service ports from private networks"

fn spec.userConfig.private_access.withPg

withPg(pg)

"Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations"

fn spec.userConfig.private_access.withPgbouncer

withPgbouncer(pgbouncer)

"Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations"

fn spec.userConfig.private_access.withPrometheus

withPrometheus(prometheus)

"Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations"

obj spec.userConfig.public_access

"Allow access to selected service ports from the public Internet"

fn spec.userConfig.public_access.withPg

withPg(pg)

"Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network"

fn spec.userConfig.public_access.withPgbouncer

withPgbouncer(pgbouncer)

"Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network"

fn spec.userConfig.public_access.withPrometheus

withPrometheus(prometheus)

"Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network"

obj spec.userConfig.timescaledb

"TimescaleDB extension configuration values"

fn spec.userConfig.timescaledb.withMax_background_workers

withMax_background_workers(max_background_workers)

"timescaledb.max_background_workers The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time."