vertica-nodejs

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-nodejs
• v-pool
• v-connection-string
• v-protocol

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

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.

Troubleshooting and FAQ

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

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.