collimator
Advanced tools
Collimator is a JavaScript library that uses reflection techniques to introspect PostgreSQL databases:
Traditionally, programmers have defined their schema by writing model definitions in application code. Some kind of migration tool then transforms this schema into SQL, and applies it against a database.
Collimator allows this pattern to be reversed. The database now becomes the canonical source of your application's schema and relationship metadata.
Install as a dependency in your application with npm install --save collimator.
Enumerate table names and primary keys with collimator.tables(db).
Generate JSON Schema with collimator.schema(db, 'tableName').
Extract relationship information with collimator.relationships(db, 'tableName').
The top-level Collimator functions (tables, schema and relationships) accept a pg-promise Database instance as their first argument, and return a promise. For further guidance, please refer to the examples and API Documentation.
collimator.tables() also accepts a second optional options parameter. The following options are supported:
looseNumbers - when true, then 'loose number' mode will be enabled. In
this mode, numeric column types will be rendered to the JSON Schema document
as {oneOf: [{type: 'number'}, {type: 'string', pattern: ...}]}.
If the column is an integer or similar, then the regular expression ^\d+$
will be used. For decimals, ^[1-9]\d*(\.\d+)?$ will be used.
This project adheres to Semantic Versioning. For a list of detailed changes, please refer to CHANGELOG.md.
Please see CONTRIBUTING.md.
The approach to schema extraction is inspired by DDL.js. Collimator's implementation is currently not as robust as DDL.js, and only targets PostgreSQL (an intentional design decision, and unlikely to change). However, Collimator supports the extraction of relationship information.
collimator is released under the BSD 3-clause “New” License.
FAQs
Reflection & Introspection for PostgreSQL Databases
The npm package collimator receives a total of 9 weekly downloads. As such, collimator popularity was classified as not popular.
We found that collimator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
