Skip to content

Commit dbc2335

Browse files
committed
update readme
1 parent 9c845e9 commit dbc2335

File tree

2 files changed

+1727
-98
lines changed

2 files changed

+1727
-98
lines changed

README.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,9 @@
1-
# MySQL DB Connector
1+
# Snowflake DB Connector
22

33
Wrapper utility to easily manage multiple data sources and pooled connections.
44

5-
## Error Returns
5+
Docs
6+
======================================================================
67

7-
By default, all errors occurring during a query are returned. If you want to be extra-safe in a production environment, you can set `HIDE_DB_ERRORS` value on the root `config` passed to the connector on initialization. When you do this, all errors will be logged, but none returned when a query error occurs.
8-
9-
## SSL Settings
10-
11-
This connector allows setting SSL connection using a few different options.
12-
13-
You can provide a custom cert:
14-
15-
```
16-
SSL: {
17-
CUSTOM_CERT: // custom cert string
18-
}
19-
```
20-
21-
By default, when specifying an SSL object, the mysql connector will reject unauthorized calls by adding `rejectUnauthorized: true`. You may override this setting by specifying a value for `REJECT_UNAUTHORIZED` in your `SSL` config:
22-
23-
```
24-
SSL: {
25-
REJECT_UNAUTHORIZED: false // not recommended
26-
}
27-
```
28-
29-
#Data Typing Options
30-
31-
This connector gives you a few options for configuring how data is returned from the connector. 'typeCast' defaults to true, and converts
32-
data from the database to its javascript equivalent. For example, it will convert DATETIME SQL objects to a DATE javascript type.
33-
You can also set 'dateStrings' which defaults to false. If you set it to true it will override typeCast and force date returns to be a string instead of a DATE type.
8+
For detailed documentation and basic usage examples, please see the documentation
9+
at `NodeJS Driver for Snowflake <https://docs.snowflake.com/en/user-guide/nodejs-driver-use.html>`_

0 commit comments

Comments
 (0)