DatabaseArgs class
The set of arguments for Database. The set of arguments for Database.
Constructors
-
DatabaseArgs({Input<
bool> ? allowConnections, Input<bool> ? alterObjectOwnership, Input<int> ? connectionLimit, Input<String> ? encoding, Input<bool> ? isTemplate, Input<String> ? lcCollate, Input<String> ? lcCtype, Input<String> ? name, Input<String> ? owner, Input<String> ? tablespaceName, Input<String> ? template}) -
Creates a new DatabaseArgs.
allowConnectionsIffalsethen no one can connect to thisalterObjectOwnershipIftrue, the change of the databaseconnectionLimitHow many concurrent connections can beencodingCharacter set encoding to use in the database.isTemplateIftrue, then this database can be cloned by anylcCollateCollation order (LC_COLLATE) to use in thelcCtypeCharacter classification (LC_CTYPE) to use in thenameThe name of the database. Must be unique on the PostgreSQLownerThe role name of the user who will own the database, ortablespaceNameThe name of the tablespace that will betemplateThe name of the template database from which to createconst -
DatabaseArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allowConnections
→ Input<
bool> ? -
If
falsethen no one can connect to this database. The default istrue, allowing connections (except as restricted by other mechanisms, such asGRANTorREVOKE CONNECT).final -
alterObjectOwnership
→ Input<
bool> ? -
If
true, the change of the databaseownerwill also include a reassignment of the ownership of preexisting objects like tables or sequences from the previous owner to the new one. If set tofalse(the default), then the previous databaseownerwill still hold the ownership of the objects in that database. To alter existing objects in the database, you must be a direct or indirect member of the specified role, or the username in the provider must be superuser.final -
connectionLimit
→ Input<
int> ? -
How many concurrent connections can be
established to this database.
-1(the default) means no limit.final -
encoding
→ Input<
String> ? -
Character set encoding to use in the database.
Specify a string constant (e.g.
UTF8orSQL_ASCII), or an integer encoding number. If unset or set to an empty string the default encoding is set toUTF8. If set toDEFAULTTerraform will use the same encoding as the template database. Changing this value will force the creation of a new resource as this value can only be changed when a database is created.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
isTemplate
→ Input<
bool> ? -
If
true, then this database can be cloned by any user withCREATEDBprivileges; iffalse(the default), then only superusers or the owner of the database can clone it.final -
lcCollate
→ Input<
String> ? -
Collation order (
LC_COLLATE) to use in the database. This affects the sort order applied to strings, e.g. in queries withORDER BY, as well as the order used in indexes on text columns. If unset or set to an empty string the default collation is set toC. If set toDEFAULTTerraform will use the same collation order as the specifiedtemplatedatabase. Changing this value will force the creation of a new resource as this value can only be changed when a database is created.final -
lcCtype
→ Input<
String> ? -
Character classification (
LC_CTYPE) to use in the database. This affects the categorization of characters, e.g. lower, upper and digit. If unset or set to an empty string the default character classification is set toC. If set toDEFAULTTerraform will use the character classification of the specifiedtemplatedatabase. Changing this value will force the creation of a new resource as this value can only be changed when a database is created.final -
name
→ Input<
String> ? -
The name of the database. Must be unique on the PostgreSQL
server instance where it is configured.
final
-
owner
→ Input<
String> ? -
The role name of the user who will own the database, or
DEFAULTto use the default (namely, the user executing the command). To create a database owned by another role or to change the owner of an existing database, you must be a direct or indirect member of the specified role, or the username in the provider is a superuser.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
tablespaceName
→ Input<
String> ? -
The name of the tablespace that will be
associated with the database, or
DEFAULTto use the template database's tablespace. This tablespace will be the default tablespace used for objects created in this database.final -
template
→ Input<
String> ? -
The name of the template database from which to create
the database, or
DEFAULTto use the default template (template0). NOTE: the default in Terraform istemplate0, nottemplate1. Changing this value will force the creation of a new resource as this value can only be changed when a database is created.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited