DedicatedDatabase class
DedicatedDatabase
- Implemented types
Constructors
-
DedicatedDatabase({required String $id, required String $createdAt, required String $updatedAt, required String projectId, required String name, required String api, required String engine, required String version, required String specification, required String backend, required String hostname, required int connectionPort, required String connectionUser, required String connectionPassword, required String connectionString, required bool ssl, required String status, required String containerStatus, String? lastAccessedAt, String? idleUntil, required String lifecycleState, required int idleTimeoutMinutes, required int cpu, required int memory, required int storage, required String storageClass, required int storageMaxGb, required String nodePool, required int replicas, required String syncMode, required int crossRegionReplicas, required int networkMaxConnections, required int networkIdleTimeoutSeconds, required List<
String> networkIPAllowlist, required bool backupEnabled, required bool pitr, required int pitrRetentionDays, required bool storageAutoscaling, required int storageAutoscalingThresholdPercent, required int storageAutoscalingMaxGb, required String maintenanceWindowDay, required int maintenanceWindowHourUtc, required bool metricsEnabled, required bool sqlApiEnabled, required List<String> sqlApiAllowedStatements, required int sqlApiMaxRows, required int sqlApiMaxBytes, required int sqlApiTimeoutSeconds, required String error}) -
DedicatedDatabase.fromMap(Map<
String, dynamic> map) -
factory
Properties
- $createdAt → String
-
Database creation time in ISO 8601 format.
final
- $id → String
-
Dedicated database ID.
final
- $updatedAt → String
-
Database update date in ISO 8601 format.
final
- api → String
-
Product API that owns this database: tablesdb, documentsdb, vectorsdb, mysql, postgresql, or mongodb.
final
- backend → String
-
Database backend provider. Possible values: prisma, edge.
final
- backupEnabled → bool
-
Whether automatic backups are enabled.
final
- connectionPassword → String
-
Database password for connections.
final
- connectionPort → int
-
Database port for connections.
final
- connectionString → String
-
Full database connection string (URI format).
final
- connectionUser → String
-
Database username for connections.
final
- containerStatus → String
-
Container status for lifecycle-managed database runtimes: active or inactive.
final
- cpu → int
-
CPU allocated in millicores.
final
- crossRegionReplicas → int
-
Number of cross-region replicas. Cross-region availability is enabled when greater than 0.
final
- engine → String
-
Database engine: postgresql, mysql, mariadb, or mongodb.
final
- error → String
-
Error message if status is failed.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hostname → String
-
Database hostname for connections.
final
- idleTimeoutMinutes → int
-
Minutes of inactivity before container scales to zero.
final
- idleUntil → String?
-
Display-only timestamp when the database is expected to be considered idle (ISO 8601 format). Derived from last activity; lifecycle transitions are driven by lifecycleState.
final
- lastAccessedAt → String?
-
Last activity timestamp in ISO 8601 format.
final
- lifecycleState → String
-
Idle-lifecycle state of the database. Possible values: active, warm, cold, hibernated.
final
- maintenanceWindowDay → String
-
Day of the week for the maintenance window. Possible values: sun, mon, tue, wed, thu, fri, sat.
final
- maintenanceWindowHourUtc → int
-
Hour in UTC (0-23) when the maintenance window starts.
final
- memory → int
-
Memory allocated in MB.
final
- metricsEnabled → bool
-
Whether metrics collection is enabled.
final
- name → String
-
Database display name.
final
- networkIdleTimeoutSeconds → int
-
Connection idle timeout in seconds.
final
-
networkIPAllowlist
→ List<
String> -
IP addresses/CIDR ranges allowed to connect.
final
- networkMaxConnections → int
-
Maximum concurrent connections.
final
- nodePool → String
-
Kubernetes node pool where the database is scheduled.
final
- pitr → bool
-
Whether point-in-time recovery is enabled.
final
- pitrRetentionDays → int
-
Number of days to retain PITR data.
final
- projectId → String
-
Project ID that owns this database.
final
- replicas → int
-
Number of high availability replicas. High availability is enabled when greater than 0.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- specification → String
-
Specification identifier.
final
-
sqlApiAllowedStatements
→ List<
String> -
Statement types accepted by the SQL API. Defaults to read/write DML only; DDL/DCL types (CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE) are opt-in per database. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.
final
- sqlApiEnabled → bool
-
Whether the SQL API sidecar is enabled for this database.
final
- sqlApiMaxBytes → int
-
Maximum serialised SQL API result payload in bytes. Results larger than this are truncated.
final
- sqlApiMaxRows → int
-
Maximum rows returned per SQL API execution. Results larger than this are truncated.
final
- sqlApiTimeoutSeconds → int
-
Maximum server-side SQL API execution time in seconds before the query is cancelled.
final
- ssl → bool
-
Whether SSL/TLS is required for client connections.
final
- status → String
-
Database status. Possible values: provisioning, ready, inactive, paused, failed, deleted, restoring, scaling.
final
- storage → int
-
Storage allocated in GB.
final
- storageAutoscaling → bool
-
Whether automatic storage expansion is enabled.
final
- storageAutoscalingMaxGb → int
-
Maximum storage size in GB for autoscaling. 0 means no limit.
final
- storageAutoscalingThresholdPercent → int
-
Storage usage percentage that triggers automatic expansion.
final
- storageClass → String
-
Storage class. Currently always 'ssd'; DigitalOcean exposes a single block-storage class.
final
- storageMaxGb → int
-
Maximum storage allowed in GB. 0 means use system default.
final
- syncMode → String
-
Replication sync mode: async, sync, or quorum.
final
- version → String
-
Database engine version.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited