@azimutt/connector-couchbase
v0.1.2
Published
Connect to Couchbase, extract schema, run analysis and queries
Downloads
168
Readme
Couchbase connector
This library allows to connect to Couchbase, extract its schema and more...
It browses all buckets, scopes and collections, fetch a sample of documents and then infer a schema from them.
This library is made by Azimutt to allow people to explore their Couchbase database. It's accessible through the Desktop app (soon), the CLI or even the website using the gateway server.
Feel free to use it and even submit PR to improve it:
- improve Couchbase queries (look at
getSchema
function) - improve schema inference
Set up a sample Couchbase database
- Go on https://www.couchbase.com and click on "Explore Now" and then "Get Started" to create your Capella account (Couchbase in the cloud)
- Once your account is created, you have 2 needed configurations:
- In
Settings > Internet
: Allow your IP address - In
Settings > Database Access
: Create database access
- In
- Build you connection url:
couchbases://<user>:<password>@<connection string>
, ex:couchbases://my_user:[email protected]
Publish
- update
package.json
version - update lib versions (
pnpm -w run update
+ manual) - test with
pnpm run dry-publish
and checkazimutt-connector-couchbase-x.y.z.tgz
content - launch
pnpm publish --no-git-checks --access public
View it on npm.
Dev
If you need to develop on multiple libs at the same time (ex: want to update a connector and try it through the CLI), depend on local libs but publish & revert before commit.
- Depend on a local lib:
pnpm add <lib>
, ex:pnpm add @azimutt/models
- "Publish" lib locally by building it:
pnpm run build