Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 4.07 KB

README.md

File metadata and controls

82 lines (52 loc) · 4.07 KB
Raw

vertica-nodejs

License NPM version NPM downloads

Non-blocking Vertica client for Node.js. Pure JavaScript and optional native libpq bindings.

DISCLAIMER:

vertica-nodejs is still pre-release and actively being improved. As of 5/5/22 this is not intended for use in production environments.

Monorepo

This repo is a monorepo which contains the core vertica-nodejs module as well as a handful of related modules.

Vertica Data Types

See DATATYPES.md to view the mappings from type IDs to Vertica data types.

Features

  • Pure JavaScript client and native libpq bindings share the same API
  • Connection pooling
  • Extensible JS ↔ Vertica data-type coercion

Support

vertica-nodejs is free software. If you encounter a bug with the library please open an issue on the GitHub repo. If you have questions unanswered by the documentation please open an issue pointing out how the documentation was unclear and we will address it as needed.

When you open an issue please provide:

  • version of Node
  • version of Vertica
  • smallest possible snippet of code to reproduce the problem

Examples

See the examples directory for sample applications showing how to use the vertica-nodejs client driver.

Setting up for local development

  1. Clone the repo
  2. From your workspace root run yarn and then yarn lerna bootstrap
  3. Ensure you have a Vertica instance running with
  4. Ensure you have the proper environment variables configured for connecting to the instance (V_HOST, V_PORT, V_USER, V_PASSWORD, V_DATABASE, V_BACKUP_SERVER_NODE)
  5. Run yarn test to run all the tests, or run yarn test from within an individual package to only run that package's tests

If using VS Code, you can install the Remote - Containers extension and it will use the configuration under the .devcontainer folder to automatically create dev containers, including Vertica. See here for more information on developing in containers using VS Code. This process will complete steps 2 to 4 above.

Troubleshooting and FAQ

The causes and solutions to common errors can be found among the Frequently Asked Questions (FAQ)

License

Apache 2.0 License, please see LICENSE for details.