Search.../

listExternalDatabaseConnections( )

Developer Preview

Retrieves a list of all external database collections associated with the site or project.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function listExternalDatabaseConnections(options: ListExternalDatabaseConnectionsOptions): Promise<ListExternalDatabaseConnectionsResponse>

listExternalDatabaseConnections Parameters

NAME
TYPE
DESCRIPTION
options
Optional
ListExternalDatabaseConnectionsOptions

Returns

Return Type:

Promise<
ListExternalDatabaseConnectionsResponse
>
NAME
TYPE
DESCRIPTION
externalDatabaseConnections
Array<
ExternalDatabaseConnection
>

List of external database connections.

pagingMetadata
PagingMetadata

Paging metadata

Was this helpful?

List existing external database connections with pagination

Copy Code
1import { Permissions, webMethod } from "wix-web-module";
2import { externalDatabaseConnections } from "wix-data.v2";
3import { elevate } from "wix-auth";
4
5const elevatedListExternalDbConnections = elevate(externalDatabaseConnections.listExternalDatabaseConnections);
6
7/* Sample options object:
8 *
9 * {
10 * paging: {
11 * limit: 3,
12 * offset: 1
13 * }
14 * }
15 */
16
17export const myListExternalDatabaseConnectionsFunctionOptions = webMethod(
18 Permissions.Admin,
19 async (options) => {
20 try {
21 const listExternalDbConnectionsResponse = await elevatedListExternalDbConnections(options);
22
23 const firstConnectionName = listExternalDbConnectionsResponse.externalDatabaseConnections[0].name;
24 const firstConnectionHaveCollections = listExternalDbConnectionsResponse.externalDatabaseConnections[0].connectionStatus.hasCollections;
25
26 console.log('Here is a list of all current external database connections: ', listExternalDbConnectionsResponse.externalDatabaseConnections);
27
28 return listExternalDbConnectionsResponse;
29 } catch (error) {
30 console.error(error);
31 // Handle the error
32 }
33 }
34)
35
36/* Promise resolves to:
37 * {
38 * "externalDatabaseConnections": [
39 * {
40 * "capabilities": {
41 * "collectionModificationsSupported": false,
42 * "fieldTypes": []
43 * }
44 * "configuration": {
45 * "secretKey": "kvod85qz-fk40-mfi5-mfi4-mflqpmgl4f1"
46 * },
47 * "connectionStatus": {
48 * "successful": true,
49 * "causeOfFailure": "NONE",
50 * "hasCollections": "YES"
51 * },
52 * "endpoint": "https://example.com/my-external-database",
53 * "name": "connectionFour",
54 * "protocolVersion": "V2",
55 * },
56 * {
57 * "capabilities": {
58 * "collectionModificationsSupported": false,
59 * "fieldTypes": []
60 * }
61 * "configuration": {
62 * "secretKey": "lfoe8tfd-fl35-mfo4-mfd1-mvkf99bjfi30"
63 * },
64 * "connectionStatus": {
65 * "successful": true,
66 * "causeOfFailure": "NONE",
67 * "hasCollections": "YES"
68 * },
69 * "endpoint": "https://example.com/my-external-database",
70 * "name": "connectionThree",
71 * "protocolVersion": "V2",
72 * },
73 * {
74 * "capabilities": {
75 * "collectionModificationsSupported": false,
76 * "fieldTypes": []
77 * }
78 * "configuration": {
79 * "secretKey": "fkapguvn-kf5z-kfo4-kg94-nfoem4pamfi6"
80 * },
81 * "connectionStatus": {
82 * "successful": true,
83 * "causeOfFailure": "NONE",
84 * "hasCollections": "YES"
85 * },
86 * "endpoint": "https://example.com/my-external-database",
87 * "name": "connectionTwo",
88 * "protocolVersion": "V2",
89 * }
90 * ],
91 * "pagingMetadata": {
92 * "count": 3,
93 * "offset": 1,
94 * "total": 5,
95 * "tooManyToCount": false
96 * }
97 * }
98 */
List existing external database connections

Copy Code
1import { Permissions, webMethod } from "wix-web-module";
2import { externalDatabaseConnections } from "wix-data.v2";
3import { elevate } from "wix-auth";
4
5const elevatedListExternalDbConnections = elevate(externalDatabaseConnections.listExternalDatabaseConnections);
6
7export const myListExternalDatabaseConnectionsFunction = webMethod(
8 Permissions.Admin,
9 async () => {
10 try {
11 const listExternalDbConnectionsResponse = await elevatedListExternalDbConnections();
12
13 const firstConnectionName = listExternalDbConnectionsResponse.externalDatabaseConnections[0].name;
14 const firstConnectionHaveCollections = listExternalDbConnectionsResponse.externalDatabaseConnections[0].connectionStatus.hasCollections;
15
16 console.log('Here is a list of all current external database connections: ', listExternalDbConnectionsResponse.externalDatabaseConnections);
17
18 return listExternalDbConnectionsResponse;
19 } catch (error) {
20 console.error(error);
21 // Handle the error
22 }
23 }
24)
25
26/* Promise resolves to:
27 * [
28 * {
29 * "capabilities": {
30 * "collectionModificationsSupported": false,
31 * "fieldTypes": []
32 * }
33 * "configuration": {
34 * "secretKey": "fkapmf9s-kf5z-lg04-mfia-kfo294pamvi5"
35 * },
36 * "connectionStatus": {
37 * "successful": true,
38 * "causeOfFailure": "NONE",
39 * "hasCollections": "YES"
40 * },
41 * "endpoint": "https://example.com/my-external-database",
42 * "name": "connection1",
43 * "protocolVersion": "V2",
44 * },
45 * {
46 * "capabilities": {
47 * "collectionModificationsSupported": false,
48 * "fieldTypes": []
49 * }
50 * "configuration": {
51 * "secretKey": "ukapguvn-kf5z-kfo4-kg94-nfoem4pamfi6"
52 * },
53 * "connectionStatus": {
54 * "successful": true,
55 * "causeOfFailure": "NONE",
56 * "hasCollections": "YES"
57 * },
58 * "endpoint": "https://example.com/my-external-database",
59 * "name": "connectionFour",
60 * "protocolVersion": "V2",
61 * },
62 * {
63 * "capabilities": {
64 * "collectionModificationsSupported": false,
65 * "fieldTypes": []
66 * }
67 * "configuration": {
68 * "secretKey": "kf0pguvn-mgoi-kfo4-kg94-nfoefds5mfi6"
69 * },
70 * "connectionStatus": {
71 * "successful": true,
72 * "causeOfFailure": "NONE",
73 * "hasCollections": "YES"
74 * },
75 * "endpoint": "https://example.com/my-external-database",
76 * "name": "connectionThree",
77 * "protocolVersion": "V2",
78 * },
79 * {
80 * "capabilities": {
81 * "collectionModificationsSupported": false,
82 * "fieldTypes": []
83 * }
84 * "configuration": {
85 * "secretKey": "fergfy84-kf5z-fdsf-kg94-nfoegfdg67i6"
86 * },
87 * "connectionStatus": {
88 * "successful": true,
89 * "causeOfFailure": "NONE",
90 * "hasCollections": "YES"
91 * },
92 * "endpoint": "https://example.com/my-external-database",
93 * "name": "connectionTwo",
94 * "protocolVersion": "V2",
95 * },
96 * {
97 * "applicationId": "8b7e9a62-t5hd-4372-gres-c6fb7762600b"
98 * "connectionStatus": {
99 * "successful": false,
100 * "causeOfFailure": "DESTINATION_ENDPOINT_NOT_DEFINED",
101 * "hasCollections": "UNKNOWN"
102 * },
103 * "name": "extDbSpi",
104 * "protocolVersion": "V3",
105 * }
106 * ]
107 */