> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Method name: getExternalDatabaseConnection(name: string)

# Method package: wixDataV2

# Method menu location: wixDataV2 --> externalDatabaseConnections --> getExternalDatabaseConnection

# Method Link: https://dev.wix.com/docs/velo/apis/wix-data-v2/external-database-connections/get-external-database-connection.md

# Method Description:

Retrieves the specified external database connection.



# Method Code Examples:

*** Note: do not assume any prop names or enum values other than the ones in the example.

## Get an external database connection (dashboard page code) 

```javascript
import { externalDatabaseConnections } from "wix-data.v2";
import { elevate } from "wix-auth";

const elevatedGetExternalDbConnection = elevate(externalDatabaseConnections.getExternalDatabaseConnection);

/* 
 * Sample name value: 'ConnectionOne'
 */

export async function myGetExternalDbConnection (name) {
  try {
    const getExternalDbConnectionResponse = await elevatedGetExternalDbConnection(name);

    const connectionSuccessful = getExternalDbConnectionResponse.connectionStatus.successful; 
    const dbEndpoint = getExternalDbConnectionResponse.endpoint;

    console.log(`Retrieved the ${name} external database connection, which is ${connectionSuccessful ? 'successful' : 'unsuccessful'}`);
    console.log(`It is mounted at ${dbEndpoint}`);

    return getExternalDbConnectionResponse;
  } catch (error) {
    console.error(error);
    // Handle the error
  }        
}

/* Promise resolves to:
 * 
 * {
 *   "capabilities": {
 *     "collectionModificationsSupported": true,
 *     "fieldTypes": []
 *   }
 *   "configuration": {
 *     "secretKey": "74dbd6d6-ec5b-4668-8229-c77379bc6431"
 *   },
 *   "connectionStatus": {
 *     "causeOfFailure": "NONE",
 *     "hasCollections": "YES"
 *     "successful": true,
 *   },
 *   "endpoint": "https://example.com/my-external-database",
 *   "name": "connectionOne",
 *   "protocolVersion": "V2"
 * }
 */
```

## Get an external database connection (export from backend code) 

```javascript
import { Permissions, webMethod } from "wix-web-module";
import { externalDatabaseConnections } from "wix-data.v2";
import { elevate } from "wix-auth";

const elevatedGetExternalDbConnection = elevate(externalDatabaseConnections.getExternalDatabaseConnection);

/* 
 * Sample name value: 'ConnectionOne'
 */

export const myGetExternalDbConnection = webMethod(
  Permissions.Admin,
  async (name) => {
    try {
      const getExternalDbConnectionResponse = await elevatedGetExternalDbConnection(name);

      const connectionSuccessful = getExternalDbConnectionResponse.connectionStatus.successful; 
      const dbEndpoint = getExternalDbConnectionResponse.endpoint;

      console.log(`Retrieved the ${name} external database connection, which is ${connectionSuccessful ? 'successful' : 'unsuccessful'}`);
      console.log(`It is mounted at ${dbEndpoint}`);

      return getExternalDbConnectionResponse;
    } catch (error) {
      console.error(error);
      // Handle the error
    }        
  }
)

/* Promise resolves to:
 * 
 * {
 *   "capabilities": {
 *     "collectionModificationsSupported": true,
 *     "fieldTypes": []
 *   }
 *   "configuration": {
 *     "secretKey": "74dbd6d6-ec5b-4668-8229-c77379bc6431"
 *   },
 *   "connectionStatus": {
 *     "causeOfFailure": "NONE",
 *     "hasCollections": "YES"
 *     "successful": true,
 *   },
 *   "endpoint": "https://example.com/my-external-database",
 *   "name": "connectionOne",
 *   "protocolVersion": "V2"
 * }
 */
```

---