Skip to content

Commit 09f4931

Browse files
authored
docs: configuration profiles limitation for mysql (#397)
1 parent 98fcda0 commit 09f4931

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/using-the-nodejs-wrapper/ConfigurationPresets.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@
44

55
A Configuration Preset is a [configuration profile](./UsingTheNodejsWrapper.md#configuration-profiles) that has already been set up by the AWS Advanced NodeJS Wrapper team. Preset configuration profiles are optimized, profiled, verified and can be used right away. If the existing presets do not cover an exact use case, users can also create their own configuration profiles based on the built-in presets.
66

7+
> [!WARNING]
8+
> Configuration profiles can only be used to connect to PostgreSQL sources. An error will be thrown when attempting a connection to a MySQL source.
9+
710
## Using Configuration Presets
811

912
The Configuration Preset name should be specified with the [`profileName`](./UsingTheNodejsWrapper.md#connection-plugin-manager-parameters) parameter.
1013

1114
```typescript
12-
const client = new AwsMySQLClient({
15+
const client = new AwsPGClient({
1316
...
1417
profileName: "A2"
1518
});
@@ -27,7 +30,7 @@ ConfigurationProfileBuilder.get()
2730
.withDatabaseDialect(new CustomDatabaseDialect())
2831
.buildAndSet();
2932

30-
const client = new AwsMySQLClient({
33+
const client = new AwsPGClient({
3134
...
3235
profileName: "myNewProfile"
3336
});

docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,9 @@ For more information, see [Custom Plugins](../development-guide/LoadablePlugins.
139139

140140
### Configuration Profiles
141141

142+
> [!WARNING]
143+
> Configuration profiles can only be used to connect to PostgreSQL sources. An error will be thrown when attempting a connection to a MySQL source.
144+
142145
An alternative way of loading plugins and providing configuration parameters is to use a configuration profile. You can create custom configuration profiles that specify which plugins the AWS Advanced NodeJS Wrapper should load. After creating the profile, set the [`profileName`](#connection-plugin-manager-parameters) parameter to the name of the created profile.
143146
This method of loading plugins will most often be used by those who require custom plugins that cannot be loaded with the [`plugins`](#connection-plugin-manager-parameters) parameter, or by those who are using preset configurations.
144147

@@ -159,7 +162,7 @@ ConfigurationProfileBuilder.get()
159162
.buildAndSet();
160163

161164
// Use the configuration profile "testProfile"
162-
const client = new AwsMySQLClient({
165+
const client = new AwsPGClient({
163166
user: "user",
164167
password: "password",
165168
host: "host",

0 commit comments

Comments
 (0)