@appwrite.io/console 16.0.0 → 17.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -6
- package/dist/cjs/package.json +1 -1
- package/dist/cjs/sdk.js +8558 -4805
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/package.json +1 -1
- package/dist/esm/sdk.js +8559 -4806
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +8558 -4805
- package/package.json +59 -50
- package/types/client.d.ts +2 -13
- package/types/enums/{addon.d.ts → addon-key.d.ts} +1 -1
- package/types/enums/authentication-factor.d.ts +2 -1
- package/types/enums/billing-plan-group.d.ts +2 -1
- package/types/enums/build-runtime.d.ts +4 -1
- package/types/enums/cache-database.d.ts +1 -2
- package/types/enums/embedding-model.d.ts +1 -3
- package/types/enums/execution-resource-type.d.ts +4 -0
- package/types/enums/framework.d.ts +1 -0
- package/types/enums/id-token-provider.d.ts +4 -0
- package/types/enums/image-gravity.d.ts +1 -0
- package/types/enums/o-auth-provider.d.ts +5 -0
- package/types/enums/organization-key-scopes.d.ts +2 -4
- package/types/enums/project-email-template-id.d.ts +2 -1
- package/types/enums/project-key-scopes.d.ts +20 -3
- package/types/enums/project-o-auth-provider-id.d.ts +5 -0
- package/types/enums/project-policy-id.d.ts +2 -0
- package/types/enums/query-suggestion-resource.d.ts +2 -3
- package/types/enums/runtime.d.ts +4 -1
- package/types/enums/usage-event-dimension.d.ts +7 -1
- package/types/enums/usage-event-metric.d.ts +55 -0
- package/types/enums/usage-gauge-metric.d.ts +50 -0
- package/types/index.d.ts +11 -6
- package/types/models.d.ts +696 -776
- package/types/services/account.d.ts +124 -36
- package/types/services/apps.d.ts +6 -6
- package/types/services/avatars.d.ts +44 -0
- package/types/services/console.d.ts +2 -2
- package/types/services/databases.d.ts +8 -8
- package/types/services/documents-db.d.ts +13 -7
- package/types/services/domains.d.ts +82 -54
- package/types/services/functions.d.ts +6 -6
- package/types/services/manager.d.ts +14 -14
- package/types/services/messaging.d.ts +80 -6
- package/types/services/mongo.d.ts +17 -23
- package/types/services/mysql.d.ts +17 -23
- package/types/services/organization.d.ts +165 -0
- package/types/services/organizations.d.ts +24 -24
- package/types/services/postgresql.d.ts +17 -23
- package/types/services/project.d.ts +218 -51
- package/types/services/projects.d.ts +0 -94
- package/types/services/sites.d.ts +15 -8
- package/types/services/storage.d.ts +2 -2
- package/types/services/tables-db.d.ts +37 -12
- package/types/services/teams.d.ts +0 -25
- package/types/services/usage.d.ts +23 -14
- package/types/services/users.d.ts +26 -29
- package/types/services/vectors-db.d.ts +15 -9
- package/types/services/waf.d.ts +11 -2
- package/types/enums/project-usage-range.d.ts +0 -4
|
@@ -690,6 +690,68 @@ export declare class Messaging {
|
|
|
690
690
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
691
691
|
*/
|
|
692
692
|
updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider>;
|
|
693
|
+
/**
|
|
694
|
+
* Create a new Appwrite push provider.
|
|
695
|
+
*
|
|
696
|
+
* @param {string} params.providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
697
|
+
* @param {string} params.name - Provider name.
|
|
698
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
699
|
+
* @param {number} params.qos - Default QoS for topics on this provider (0 or 1). Null lets the subscriber choose.
|
|
700
|
+
* @param {number} params.expiry - Default message retention in seconds for offline delivery. Max 7 days (604800).
|
|
701
|
+
* @throws {AppwriteException}
|
|
702
|
+
* @returns {Promise<Models.Provider>}
|
|
703
|
+
*/
|
|
704
|
+
createAppwriteProvider(params: {
|
|
705
|
+
providerId: string;
|
|
706
|
+
name: string;
|
|
707
|
+
enabled?: boolean;
|
|
708
|
+
qos?: number;
|
|
709
|
+
expiry?: number;
|
|
710
|
+
}): Promise<Models.Provider>;
|
|
711
|
+
/**
|
|
712
|
+
* Create a new Appwrite push provider.
|
|
713
|
+
*
|
|
714
|
+
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
715
|
+
* @param {string} name - Provider name.
|
|
716
|
+
* @param {boolean} enabled - Set as enabled.
|
|
717
|
+
* @param {number} qos - Default QoS for topics on this provider (0 or 1). Null lets the subscriber choose.
|
|
718
|
+
* @param {number} expiry - Default message retention in seconds for offline delivery. Max 7 days (604800).
|
|
719
|
+
* @throws {AppwriteException}
|
|
720
|
+
* @returns {Promise<Models.Provider>}
|
|
721
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
722
|
+
*/
|
|
723
|
+
createAppwriteProvider(providerId: string, name: string, enabled?: boolean, qos?: number, expiry?: number): Promise<Models.Provider>;
|
|
724
|
+
/**
|
|
725
|
+
* Update an Appwrite push provider by its unique ID.
|
|
726
|
+
*
|
|
727
|
+
* @param {string} params.providerId - Provider ID.
|
|
728
|
+
* @param {string} params.name - Provider name.
|
|
729
|
+
* @param {boolean} params.enabled - Set as enabled.
|
|
730
|
+
* @param {number} params.qos - Default QoS for topics on this provider (0 or 1). Null lets the subscriber choose.
|
|
731
|
+
* @param {number} params.expiry - Default message retention in seconds for offline delivery. Max 7 days (604800).
|
|
732
|
+
* @throws {AppwriteException}
|
|
733
|
+
* @returns {Promise<Models.Provider>}
|
|
734
|
+
*/
|
|
735
|
+
updateAppwriteProvider(params: {
|
|
736
|
+
providerId: string;
|
|
737
|
+
name?: string;
|
|
738
|
+
enabled?: boolean;
|
|
739
|
+
qos?: number;
|
|
740
|
+
expiry?: number;
|
|
741
|
+
}): Promise<Models.Provider>;
|
|
742
|
+
/**
|
|
743
|
+
* Update an Appwrite push provider by its unique ID.
|
|
744
|
+
*
|
|
745
|
+
* @param {string} providerId - Provider ID.
|
|
746
|
+
* @param {string} name - Provider name.
|
|
747
|
+
* @param {boolean} enabled - Set as enabled.
|
|
748
|
+
* @param {number} qos - Default QoS for topics on this provider (0 or 1). Null lets the subscriber choose.
|
|
749
|
+
* @param {number} expiry - Default message retention in seconds for offline delivery. Max 7 days (604800).
|
|
750
|
+
* @throws {AppwriteException}
|
|
751
|
+
* @returns {Promise<Models.Provider>}
|
|
752
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
753
|
+
*/
|
|
754
|
+
updateAppwriteProvider(providerId: string, name?: string, enabled?: boolean, qos?: number, expiry?: number): Promise<Models.Provider>;
|
|
693
755
|
/**
|
|
694
756
|
* Create a new Firebase Cloud Messaging provider.
|
|
695
757
|
*
|
|
@@ -1591,7 +1653,7 @@ export declare class Messaging {
|
|
|
1591
1653
|
*
|
|
1592
1654
|
* @param {string} params.providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1593
1655
|
* @param {string} params.name - Provider name.
|
|
1594
|
-
* @param {string} params.from - Sender
|
|
1656
|
+
* @param {string} params.from - Sender phone number or alphanumeric sender ID. Format phone numbers with a leading '+' and a country code, e.g., +16175551212.
|
|
1595
1657
|
* @param {string} params.accountSid - Twilio account secret ID.
|
|
1596
1658
|
* @param {string} params.authToken - Twilio authentication token.
|
|
1597
1659
|
* @param {boolean} params.enabled - Set as enabled.
|
|
@@ -1611,7 +1673,7 @@ export declare class Messaging {
|
|
|
1611
1673
|
*
|
|
1612
1674
|
* @param {string} providerId - Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1613
1675
|
* @param {string} name - Provider name.
|
|
1614
|
-
* @param {string} from - Sender
|
|
1676
|
+
* @param {string} from - Sender phone number or alphanumeric sender ID. Format phone numbers with a leading '+' and a country code, e.g., +16175551212.
|
|
1615
1677
|
* @param {string} accountSid - Twilio account secret ID.
|
|
1616
1678
|
* @param {string} authToken - Twilio authentication token.
|
|
1617
1679
|
* @param {boolean} enabled - Set as enabled.
|
|
@@ -1628,7 +1690,7 @@ export declare class Messaging {
|
|
|
1628
1690
|
* @param {boolean} params.enabled - Set as enabled.
|
|
1629
1691
|
* @param {string} params.accountSid - Twilio account secret ID.
|
|
1630
1692
|
* @param {string} params.authToken - Twilio authentication token.
|
|
1631
|
-
* @param {string} params.from - Sender number.
|
|
1693
|
+
* @param {string} params.from - Sender phone number or alphanumeric sender ID. Format phone numbers with a leading '+' and a country code, e.g., +16175551212.
|
|
1632
1694
|
* @throws {AppwriteException}
|
|
1633
1695
|
* @returns {Promise<Models.Provider>}
|
|
1634
1696
|
*/
|
|
@@ -1648,7 +1710,7 @@ export declare class Messaging {
|
|
|
1648
1710
|
* @param {boolean} enabled - Set as enabled.
|
|
1649
1711
|
* @param {string} accountSid - Twilio account secret ID.
|
|
1650
1712
|
* @param {string} authToken - Twilio authentication token.
|
|
1651
|
-
* @param {string} from - Sender number.
|
|
1713
|
+
* @param {string} from - Sender phone number or alphanumeric sender ID. Format phone numbers with a leading '+' and a country code, e.g., +16175551212.
|
|
1652
1714
|
* @throws {AppwriteException}
|
|
1653
1715
|
* @returns {Promise<Models.Provider>}
|
|
1654
1716
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
@@ -1793,6 +1855,8 @@ export declare class Messaging {
|
|
|
1793
1855
|
* @param {string} params.topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1794
1856
|
* @param {string} params.name - Topic Name.
|
|
1795
1857
|
* @param {string[]} params.subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1858
|
+
* @param {number} params.qos - MQTT delivery quality of service for this topic. 0 is fire-and-forget (delivered only to clients connected at publish time). 1 persists each message and replays it when a client reconnects without having acknowledged it. Null lets the subscriber choose.
|
|
1859
|
+
* @param {number} params.expiry - Message retention in seconds for offline delivery. Max 7 days (604800).
|
|
1796
1860
|
* @throws {AppwriteException}
|
|
1797
1861
|
* @returns {Promise<Models.Topic>}
|
|
1798
1862
|
*/
|
|
@@ -1800,6 +1864,8 @@ export declare class Messaging {
|
|
|
1800
1864
|
topicId: string;
|
|
1801
1865
|
name: string;
|
|
1802
1866
|
subscribe?: string[];
|
|
1867
|
+
qos?: number;
|
|
1868
|
+
expiry?: number;
|
|
1803
1869
|
}): Promise<Models.Topic>;
|
|
1804
1870
|
/**
|
|
1805
1871
|
* Create a new topic.
|
|
@@ -1807,11 +1873,13 @@ export declare class Messaging {
|
|
|
1807
1873
|
* @param {string} topicId - Topic ID. Choose a custom Topic ID or a new Topic ID.
|
|
1808
1874
|
* @param {string} name - Topic Name.
|
|
1809
1875
|
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1876
|
+
* @param {number} qos - MQTT delivery quality of service for this topic. 0 is fire-and-forget (delivered only to clients connected at publish time). 1 persists each message and replays it when a client reconnects without having acknowledged it. Null lets the subscriber choose.
|
|
1877
|
+
* @param {number} expiry - Message retention in seconds for offline delivery. Max 7 days (604800).
|
|
1810
1878
|
* @throws {AppwriteException}
|
|
1811
1879
|
* @returns {Promise<Models.Topic>}
|
|
1812
1880
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1813
1881
|
*/
|
|
1814
|
-
createTopic(topicId: string, name: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
1882
|
+
createTopic(topicId: string, name: string, subscribe?: string[], qos?: number, expiry?: number): Promise<Models.Topic>;
|
|
1815
1883
|
/**
|
|
1816
1884
|
* Get a topic by its unique ID.
|
|
1817
1885
|
*
|
|
@@ -1840,6 +1908,8 @@ export declare class Messaging {
|
|
|
1840
1908
|
* @param {string} params.topicId - Topic ID.
|
|
1841
1909
|
* @param {string} params.name - Topic Name.
|
|
1842
1910
|
* @param {string[]} params.subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1911
|
+
* @param {number} params.qos - MQTT delivery quality of service for this topic. 0 is fire-and-forget (delivered only to clients connected at publish time). 1 persists each message and replays it when a client reconnects without having acknowledged it. Null lets the subscriber choose.
|
|
1912
|
+
* @param {number} params.expiry - Message retention in seconds for offline delivery. Max 7 days (604800).
|
|
1843
1913
|
* @throws {AppwriteException}
|
|
1844
1914
|
* @returns {Promise<Models.Topic>}
|
|
1845
1915
|
*/
|
|
@@ -1847,6 +1917,8 @@ export declare class Messaging {
|
|
|
1847
1917
|
topicId: string;
|
|
1848
1918
|
name?: string;
|
|
1849
1919
|
subscribe?: string[];
|
|
1920
|
+
qos?: number;
|
|
1921
|
+
expiry?: number;
|
|
1850
1922
|
}): Promise<Models.Topic>;
|
|
1851
1923
|
/**
|
|
1852
1924
|
* Update a topic by its unique ID.
|
|
@@ -1855,11 +1927,13 @@ export declare class Messaging {
|
|
|
1855
1927
|
* @param {string} topicId - Topic ID.
|
|
1856
1928
|
* @param {string} name - Topic Name.
|
|
1857
1929
|
* @param {string[]} subscribe - An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https://appwrite.io/docs/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.
|
|
1930
|
+
* @param {number} qos - MQTT delivery quality of service for this topic. 0 is fire-and-forget (delivered only to clients connected at publish time). 1 persists each message and replays it when a client reconnects without having acknowledged it. Null lets the subscriber choose.
|
|
1931
|
+
* @param {number} expiry - Message retention in seconds for offline delivery. Max 7 days (604800).
|
|
1858
1932
|
* @throws {AppwriteException}
|
|
1859
1933
|
* @returns {Promise<Models.Topic>}
|
|
1860
1934
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1861
1935
|
*/
|
|
1862
|
-
updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic>;
|
|
1936
|
+
updateTopic(topicId: string, name?: string, subscribe?: string[], qos?: number, expiry?: number): Promise<Models.Topic>;
|
|
1863
1937
|
/**
|
|
1864
1938
|
* Delete a topic by its unique ID.
|
|
1865
1939
|
*
|
|
@@ -31,7 +31,6 @@ export declare class Mongo {
|
|
|
31
31
|
* @param {string} params.specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
32
32
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
33
33
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
34
|
-
* @param {string} params.standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
35
34
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
36
35
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
37
36
|
* @param {number} params.idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -39,7 +38,7 @@ export declare class Mongo {
|
|
|
39
38
|
* @param {number} params.pitrRetentionDays - Number of days to retain PITR data.
|
|
40
39
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
41
40
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
42
|
-
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
41
|
+
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.
|
|
43
42
|
* @throws {AppwriteException}
|
|
44
43
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
45
44
|
*/
|
|
@@ -50,7 +49,6 @@ export declare class Mongo {
|
|
|
50
49
|
specification?: string;
|
|
51
50
|
replicas?: number;
|
|
52
51
|
syncMode?: string;
|
|
53
|
-
standbyRegion?: string;
|
|
54
52
|
networkIdleTimeoutSeconds?: number;
|
|
55
53
|
networkIPAllowlist?: string[];
|
|
56
54
|
idleTimeoutMinutes?: number;
|
|
@@ -69,7 +67,6 @@ export declare class Mongo {
|
|
|
69
67
|
* @param {string} specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
70
68
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
71
69
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
72
|
-
* @param {string} standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
73
70
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
74
71
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
75
72
|
* @param {number} idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -77,14 +74,14 @@ export declare class Mongo {
|
|
|
77
74
|
* @param {number} pitrRetentionDays - Number of days to retain PITR data.
|
|
78
75
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
79
76
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
80
|
-
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
77
|
+
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.
|
|
81
78
|
* @throws {AppwriteException}
|
|
82
79
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
83
80
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
84
81
|
*/
|
|
85
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string,
|
|
82
|
+
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number): Promise<Models.DedicatedDatabase>;
|
|
86
83
|
/**
|
|
87
|
-
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits,
|
|
84
|
+
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits, its own prices and overage rates, and whether it is enabled for the organization.
|
|
88
85
|
*
|
|
89
86
|
* @throws {AppwriteException}
|
|
90
87
|
* @returns {Promise<Models.DedicatedDatabaseSpecificationList>}
|
|
@@ -118,8 +115,6 @@ export declare class Mongo {
|
|
|
118
115
|
* @param {string} params.specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
119
116
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
120
117
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
121
|
-
* @param {number} params.crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
122
|
-
* @param {string} params.standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
123
118
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
124
119
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
125
120
|
* @param {number} params.idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -145,8 +140,6 @@ export declare class Mongo {
|
|
|
145
140
|
specification?: string;
|
|
146
141
|
replicas?: number;
|
|
147
142
|
syncMode?: string;
|
|
148
|
-
crossRegionReplicas?: number;
|
|
149
|
-
standbyRegion?: string;
|
|
150
143
|
networkIdleTimeoutSeconds?: number;
|
|
151
144
|
networkIPAllowlist?: string[];
|
|
152
145
|
idleTimeoutMinutes?: number;
|
|
@@ -172,8 +165,6 @@ export declare class Mongo {
|
|
|
172
165
|
* @param {string} specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
173
166
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
174
167
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
175
|
-
* @param {number} crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
176
|
-
* @param {string} standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
177
168
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
178
169
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
179
170
|
* @param {number} idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -193,7 +184,7 @@ export declare class Mongo {
|
|
|
193
184
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
194
185
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
186
|
*/
|
|
196
|
-
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string,
|
|
187
|
+
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
|
|
197
188
|
/**
|
|
198
189
|
* Delete a dedicated database. This action is irreversible. The database status will be set to 'deleting' and all resources will be cleaned up. Deletion is allowed from any state, and repeating the call re-dispatches the cleanup.
|
|
199
190
|
*
|
|
@@ -545,26 +536,26 @@ export declare class Mongo {
|
|
|
545
536
|
*/
|
|
546
537
|
deleteBranch(databaseId: string, branchId: string): Promise<Models.DedicatedDatabase>;
|
|
547
538
|
/**
|
|
548
|
-
*
|
|
539
|
+
* Queue a rotation of the primary connection credentials for a dedicated database. A hibernated database is woken by the worker before rotation. List database operations until the returned operation reaches a terminal status, then fetch the database again for the refreshed connection string.
|
|
549
540
|
*
|
|
550
541
|
* @param {string} params.databaseId - Database ID.
|
|
551
542
|
* @throws {AppwriteException}
|
|
552
|
-
* @returns {Promise<Models.
|
|
543
|
+
* @returns {Promise<Models.DedicatedDatabaseOperation>}
|
|
553
544
|
*/
|
|
554
545
|
updateCredentials(params: {
|
|
555
546
|
databaseId: string;
|
|
556
|
-
}): Promise<Models.
|
|
547
|
+
}): Promise<Models.DedicatedDatabaseOperation>;
|
|
557
548
|
/**
|
|
558
|
-
*
|
|
549
|
+
* Queue a rotation of the primary connection credentials for a dedicated database. A hibernated database is woken by the worker before rotation. List database operations until the returned operation reaches a terminal status, then fetch the database again for the refreshed connection string.
|
|
559
550
|
*
|
|
560
551
|
* @param {string} databaseId - Database ID.
|
|
561
552
|
* @throws {AppwriteException}
|
|
562
|
-
* @returns {Promise<Models.
|
|
553
|
+
* @returns {Promise<Models.DedicatedDatabaseOperation>}
|
|
563
554
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
564
555
|
*/
|
|
565
|
-
updateCredentials(databaseId: string): Promise<Models.
|
|
556
|
+
updateCredentials(databaseId: string): Promise<Models.DedicatedDatabaseOperation>;
|
|
566
557
|
/**
|
|
567
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation
|
|
558
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation also accepts this call as a repair once nothing is driving the operation it is stuck in. Repairing a failover that did not finish, a `failed` database, a stranded upgrade or migrate, or a stranded compute resize additionally requires `targetReplicaId` to name the member to promote, because the default target may be the member that operation already promoted.
|
|
568
559
|
*
|
|
569
560
|
* @param {string} params.databaseId - Database ID.
|
|
570
561
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -576,7 +567,7 @@ export declare class Mongo {
|
|
|
576
567
|
targetReplicaId?: string;
|
|
577
568
|
}): Promise<Models.DedicatedDatabase>;
|
|
578
569
|
/**
|
|
579
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation
|
|
570
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation also accepts this call as a repair once nothing is driving the operation it is stuck in. Repairing a failover that did not finish, a `failed` database, a stranded upgrade or migrate, or a stranded compute resize additionally requires `targetReplicaId` to name the member to promote, because the default target may be the member that operation already promoted.
|
|
580
571
|
*
|
|
581
572
|
* @param {string} databaseId - Database ID.
|
|
582
573
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -738,6 +729,7 @@ export declare class Mongo {
|
|
|
738
729
|
* @param {string} params.databaseId - Database ID.
|
|
739
730
|
* @param {string} params.type - Restoration type. Allowed values: backup, pitr. Use "backup" to restore from a specific backup, or "pitr" for point-in-time recovery.
|
|
740
731
|
* @param {string} params.backupId - Backup ID to restore from (required for backup type).
|
|
732
|
+
* @param {string} params.targetDatabaseId - Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.
|
|
741
733
|
* @param {string} params.targetTime - Target time for PITR (required for pitr type) as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) datetime.
|
|
742
734
|
* @throws {AppwriteException}
|
|
743
735
|
* @returns {Promise<Models.DedicatedDatabaseRestoration>}
|
|
@@ -746,6 +738,7 @@ export declare class Mongo {
|
|
|
746
738
|
databaseId: string;
|
|
747
739
|
type?: string;
|
|
748
740
|
backupId?: string;
|
|
741
|
+
targetDatabaseId?: string;
|
|
749
742
|
targetTime?: string;
|
|
750
743
|
}): Promise<Models.DedicatedDatabaseRestoration>;
|
|
751
744
|
/**
|
|
@@ -754,12 +747,13 @@ export declare class Mongo {
|
|
|
754
747
|
* @param {string} databaseId - Database ID.
|
|
755
748
|
* @param {string} type - Restoration type. Allowed values: backup, pitr. Use "backup" to restore from a specific backup, or "pitr" for point-in-time recovery.
|
|
756
749
|
* @param {string} backupId - Backup ID to restore from (required for backup type).
|
|
750
|
+
* @param {string} targetDatabaseId - Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.
|
|
757
751
|
* @param {string} targetTime - Target time for PITR (required for pitr type) as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) datetime.
|
|
758
752
|
* @throws {AppwriteException}
|
|
759
753
|
* @returns {Promise<Models.DedicatedDatabaseRestoration>}
|
|
760
754
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
761
755
|
*/
|
|
762
|
-
createRestoration(databaseId: string, type?: string, backupId?: string, targetTime?: string): Promise<Models.DedicatedDatabaseRestoration>;
|
|
756
|
+
createRestoration(databaseId: string, type?: string, backupId?: string, targetDatabaseId?: string, targetTime?: string): Promise<Models.DedicatedDatabaseRestoration>;
|
|
763
757
|
/**
|
|
764
758
|
* Get details of a specific database restoration including its status, type, and timestamps.
|
|
765
759
|
*
|
|
@@ -31,7 +31,6 @@ export declare class Mysql {
|
|
|
31
31
|
* @param {string} params.specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
32
32
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
33
33
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
34
|
-
* @param {string} params.standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
35
34
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
36
35
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
37
36
|
* @param {number} params.idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -39,7 +38,7 @@ export declare class Mysql {
|
|
|
39
38
|
* @param {number} params.pitrRetentionDays - Number of days to retain PITR data.
|
|
40
39
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
41
40
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
42
|
-
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
41
|
+
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.
|
|
43
42
|
* @throws {AppwriteException}
|
|
44
43
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
45
44
|
*/
|
|
@@ -50,7 +49,6 @@ export declare class Mysql {
|
|
|
50
49
|
specification?: string;
|
|
51
50
|
replicas?: number;
|
|
52
51
|
syncMode?: string;
|
|
53
|
-
standbyRegion?: string;
|
|
54
52
|
networkIdleTimeoutSeconds?: number;
|
|
55
53
|
networkIPAllowlist?: string[];
|
|
56
54
|
idleTimeoutMinutes?: number;
|
|
@@ -69,7 +67,6 @@ export declare class Mysql {
|
|
|
69
67
|
* @param {string} specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
70
68
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
71
69
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
72
|
-
* @param {string} standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
73
70
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
74
71
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
75
72
|
* @param {number} idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -77,14 +74,14 @@ export declare class Mysql {
|
|
|
77
74
|
* @param {number} pitrRetentionDays - Number of days to retain PITR data.
|
|
78
75
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
79
76
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
80
|
-
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
77
|
+
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. Defaults to 3 times the specification's storage. 0 means no limit.
|
|
81
78
|
* @throws {AppwriteException}
|
|
82
79
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
83
80
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
84
81
|
*/
|
|
85
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string,
|
|
82
|
+
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number): Promise<Models.DedicatedDatabase>;
|
|
86
83
|
/**
|
|
87
|
-
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits,
|
|
84
|
+
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits, its own prices and overage rates, and whether it is enabled for the organization.
|
|
88
85
|
*
|
|
89
86
|
* @throws {AppwriteException}
|
|
90
87
|
* @returns {Promise<Models.DedicatedDatabaseSpecificationList>}
|
|
@@ -118,8 +115,6 @@ export declare class Mysql {
|
|
|
118
115
|
* @param {string} params.specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
119
116
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
120
117
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
121
|
-
* @param {number} params.crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
122
|
-
* @param {string} params.standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
123
118
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
124
119
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
125
120
|
* @param {number} params.idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -145,8 +140,6 @@ export declare class Mysql {
|
|
|
145
140
|
specification?: string;
|
|
146
141
|
replicas?: number;
|
|
147
142
|
syncMode?: string;
|
|
148
|
-
crossRegionReplicas?: number;
|
|
149
|
-
standbyRegion?: string;
|
|
150
143
|
networkIdleTimeoutSeconds?: number;
|
|
151
144
|
networkIPAllowlist?: string[];
|
|
152
145
|
idleTimeoutMinutes?: number;
|
|
@@ -172,8 +165,6 @@ export declare class Mysql {
|
|
|
172
165
|
* @param {string} specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
173
166
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
174
167
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
175
|
-
* @param {number} crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
176
|
-
* @param {string} standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
177
168
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
178
169
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
179
170
|
* @param {number} idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -193,7 +184,7 @@ export declare class Mysql {
|
|
|
193
184
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
194
185
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
186
|
*/
|
|
196
|
-
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string,
|
|
187
|
+
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
|
|
197
188
|
/**
|
|
198
189
|
* Delete a dedicated database. This action is irreversible. The database status will be set to 'deleting' and all resources will be cleaned up. Deletion is allowed from any state, and repeating the call re-dispatches the cleanup.
|
|
199
190
|
*
|
|
@@ -545,24 +536,24 @@ export declare class Mysql {
|
|
|
545
536
|
*/
|
|
546
537
|
deleteBranch(databaseId: string, branchId: string): Promise<Models.DedicatedDatabase>;
|
|
547
538
|
/**
|
|
548
|
-
*
|
|
539
|
+
* Queue a rotation of the primary connection credentials for a dedicated database. A hibernated database is woken by the worker before rotation. List database operations until the returned operation reaches a terminal status, then fetch the database again for the refreshed connection string.
|
|
549
540
|
*
|
|
550
541
|
* @param {string} params.databaseId - Database ID.
|
|
551
542
|
* @throws {AppwriteException}
|
|
552
|
-
* @returns {Promise<Models.
|
|
543
|
+
* @returns {Promise<Models.DedicatedDatabaseOperation>}
|
|
553
544
|
*/
|
|
554
545
|
updateCredentials(params: {
|
|
555
546
|
databaseId: string;
|
|
556
|
-
}): Promise<Models.
|
|
547
|
+
}): Promise<Models.DedicatedDatabaseOperation>;
|
|
557
548
|
/**
|
|
558
|
-
*
|
|
549
|
+
* Queue a rotation of the primary connection credentials for a dedicated database. A hibernated database is woken by the worker before rotation. List database operations until the returned operation reaches a terminal status, then fetch the database again for the refreshed connection string.
|
|
559
550
|
*
|
|
560
551
|
* @param {string} databaseId - Database ID.
|
|
561
552
|
* @throws {AppwriteException}
|
|
562
|
-
* @returns {Promise<Models.
|
|
553
|
+
* @returns {Promise<Models.DedicatedDatabaseOperation>}
|
|
563
554
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
564
555
|
*/
|
|
565
|
-
updateCredentials(databaseId: string): Promise<Models.
|
|
556
|
+
updateCredentials(databaseId: string): Promise<Models.DedicatedDatabaseOperation>;
|
|
566
557
|
/**
|
|
567
558
|
* Execute SQL through the console-facing Cloud endpoint. Cloud proxies through the edge platform to the per-database SQL API sidecar. Application traffic should bypass cloud entirely and POST directly to the per-database hostname: `https://db-{project}-{db}.{region}.appwrite.center/v1/sql/executions` with an `X-Appwrite-Key` header — that path scales to the whole DB fleet without a per-query cloud round-trip. The statement type must be on the database's configured allow-list. Use bound parameters for any user-supplied values — the API does not interpolate raw strings.
|
|
568
559
|
*
|
|
@@ -592,7 +583,7 @@ export declare class Mysql {
|
|
|
592
583
|
*/
|
|
593
584
|
createExecution(databaseId: string, sql: string, bindings?: object, timeoutSeconds?: number): Promise<Models.DedicatedDatabaseExecution>;
|
|
594
585
|
/**
|
|
595
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation
|
|
586
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation also accepts this call as a repair once nothing is driving the operation it is stuck in. Repairing a failover that did not finish, a `failed` database, a stranded upgrade or migrate, or a stranded compute resize additionally requires `targetReplicaId` to name the member to promote, because the default target may be the member that operation already promoted.
|
|
596
587
|
*
|
|
597
588
|
* @param {string} params.databaseId - Database ID.
|
|
598
589
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -604,7 +595,7 @@ export declare class Mysql {
|
|
|
604
595
|
targetReplicaId?: string;
|
|
605
596
|
}): Promise<Models.DedicatedDatabase>;
|
|
606
597
|
/**
|
|
607
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation
|
|
598
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation also accepts this call as a repair once nothing is driving the operation it is stuck in. Repairing a failover that did not finish, a `failed` database, a stranded upgrade or migrate, or a stranded compute resize additionally requires `targetReplicaId` to name the member to promote, because the default target may be the member that operation already promoted.
|
|
608
599
|
*
|
|
609
600
|
* @param {string} databaseId - Database ID.
|
|
610
601
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -828,6 +819,7 @@ export declare class Mysql {
|
|
|
828
819
|
* @param {string} params.databaseId - Database ID.
|
|
829
820
|
* @param {string} params.type - Restoration type. Allowed values: backup, pitr. Use "backup" to restore from a specific backup, or "pitr" for point-in-time recovery.
|
|
830
821
|
* @param {string} params.backupId - Backup ID to restore from (required for backup type).
|
|
822
|
+
* @param {string} params.targetDatabaseId - Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.
|
|
831
823
|
* @param {string} params.targetTime - Target time for PITR (required for pitr type) as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) datetime.
|
|
832
824
|
* @throws {AppwriteException}
|
|
833
825
|
* @returns {Promise<Models.DedicatedDatabaseRestoration>}
|
|
@@ -836,6 +828,7 @@ export declare class Mysql {
|
|
|
836
828
|
databaseId: string;
|
|
837
829
|
type?: string;
|
|
838
830
|
backupId?: string;
|
|
831
|
+
targetDatabaseId?: string;
|
|
839
832
|
targetTime?: string;
|
|
840
833
|
}): Promise<Models.DedicatedDatabaseRestoration>;
|
|
841
834
|
/**
|
|
@@ -844,12 +837,13 @@ export declare class Mysql {
|
|
|
844
837
|
* @param {string} databaseId - Database ID.
|
|
845
838
|
* @param {string} type - Restoration type. Allowed values: backup, pitr. Use "backup" to restore from a specific backup, or "pitr" for point-in-time recovery.
|
|
846
839
|
* @param {string} backupId - Backup ID to restore from (required for backup type).
|
|
840
|
+
* @param {string} targetDatabaseId - Existing database ID to restore into. The target must be distinct, ready, and use the same engine and version.
|
|
847
841
|
* @param {string} targetTime - Target time for PITR (required for pitr type) as an [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) datetime.
|
|
848
842
|
* @throws {AppwriteException}
|
|
849
843
|
* @returns {Promise<Models.DedicatedDatabaseRestoration>}
|
|
850
844
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
851
845
|
*/
|
|
852
|
-
createRestoration(databaseId: string, type?: string, backupId?: string, targetTime?: string): Promise<Models.DedicatedDatabaseRestoration>;
|
|
846
|
+
createRestoration(databaseId: string, type?: string, backupId?: string, targetDatabaseId?: string, targetTime?: string): Promise<Models.DedicatedDatabaseRestoration>;
|
|
853
847
|
/**
|
|
854
848
|
* Get details of a specific database restoration including its status, type, and timestamps.
|
|
855
849
|
*
|