https://github.com/tediousjs/connection-string
A connection string parsing library
https://github.com/tediousjs/connection-string
Last synced: 2 months ago
JSON representation
A connection string parsing library
- Host: GitHub
- URL: https://github.com/tediousjs/connection-string
- Owner: tediousjs
- License: mit
- Created: 2020-04-07T15:07:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-16T08:16:14.000Z (about 1 year ago)
- Last Synced: 2025-06-16T09:32:07.909Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.13 MB
- Stars: 9
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Connection String Parser
[](https://www.npmjs.com/package/@tediousjs/connection-string)
[](https://github.com/tediousjs/connection-string/actions/workflows/nodejs.yml)
This node library is designed to allow the parsing of Connection Strings see https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring
The library also provides the ability to parse SQL Connection Strings.
# Usage
## Parsing connection strings
The library comes with a generic connection string parser that will parse through valid connection strings and produce a key-value
readonly Map of the entries in that string. No additional validation is performed.
```js
const { parse } = require('@tediousjs/connection-string');
const connectionString = 'User ID=user;Password=password;Initial Catalog=AdventureWorks;Server=MySqlServer';
const parsed = parse(connectionString);
console.log(parsed);
```
Output to the console will be:
```
Map(4) {
'user id' => 'user',
'password' => 'password',
'initial catalog' => 'AdventureWorks',
'server' => 'MySqlServer'
}
```
## Parsing SQL connection strings
SQL connection strings can be parsed to a JSON object using the `toSchema()` method and the provided
`MSSQL_SCHEMA`.
```js
const { parse, MSSQL_SCHEMA } = require('@tediousjs/connection-string');
const connectionString = 'User ID=user;Password=password;Initial Catalog=AdventureWorks;Server=MySqlServer';
const parsed = parse(connectionString);
console.log(parsed.toSchema(MSSQL_SCHEMA));
```
Output to console will be:
```json
{
"data source": "MySqlServer",
"initial catalog": "AdventureWorks",
"password": "password",
"user id":"user"
}
```
NB: The `Server` property from the connection string has been re-written to the value `Data Source`
## Custom schemas
If you need to parse a connection string into a custom schema, the format is as follows:
```ts
import { parse } from '@tediousjs/connection-string';
// a keyed map of name => config
const schema = {
'a string': {
type: 'string',
default: 'a default value',
aliases: ['other', 'allowed', 'names'],
},
'a number': {
type: 'number',
default: 123,
},
'a boolean': {
type: 'boolean',
default: true,
},
};
const parsed = parse('a string=test;a number=987;a boolean=false;other value=missing');
console.log(parsed.toSchema(schema));
```
Output:
```json
{
"a string": "test",
"a number": 987,
"a boolean": false
}
```
## Accessing properties
The parsed connection string object is a readonly `Map` with an overloadded `get()` method allowing
coercion of the value:
```ts
import { parse } from '@tediousjs/connection-string';
const parsed = parse('a string=test;a number=987;a boolean=false;other value=missing');
// all values are strings by default
console.log(parsed.get('a number')); // "987"
// values can be coersed to an expected type
console.log(parsed.get('a number', 'number')); // 987
// coersion will be permissive in its type coersion
console.log(parsed.get('a number', 'boolean')); // true
```