https://github.com/featurist/sworm-schema
https://github.com/featurist/sworm-schema
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/featurist/sworm-schema
- Owner: featurist
- Created: 2017-12-01T13:12:48.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-13T11:21:52.000Z (over 6 years ago)
- Last Synced: 2025-02-20T11:17:47.546Z (2 months ago)
- Language: JavaScript
- Size: 59.6 KB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# SWORM Schema [](https://www.npmjs.com/package/sworm-schema) [](https://www.npmjs.com/package/sworm-schema) [](https://travis-ci.org/featurist/sworm-schema)
A companion to the popular [SWORM](https://github.com/featurist/sworm) ORM.
SWORM Schema is used to automate creating, deleting and cleaning of test databases.
You can also use it to validate that the schema has all the tables and columns required to run a particular query. This is really useful if you are integrating with an existing database and are trying to figure out what parts of the schema your test database needs.
## Install
`npm i sworm-schema --save-dev`
`yarn add sworm-schema --dev`
## How to use it
Firstly lets define our schema and suply a url connection string the datbase.
The most common way of using this is with sqlite:
```js
const SwormSchema = require('sworm-schema')
const swormSchema = new SwormSchema({
url: 'sqlite:test/db/test.db',
schema: {
people: {
id: {type: 'integer'},
name: {type: 'text'},
},
places: {
id: {type: 'integer'},
name: {type: 'text'},
}
}
})
```
Now create the database
```js
await swormSchema.create()
```
You'll want to use the same connection string for the application you have under test.
Or if you just want to play with database using [SWORM](https://github.com/featurist/sworm) you can just do this:
```js
const db = await swormSchema.connect()
const person = db.model({table: 'people'})
const place = db.model({table: 'places'})
await person({id: 1, name: 'bob'}).save()
await person({id: 2, name: 'julie'}).save()
await place({id: 1, name: 'stroud'}).save()
await place({id: 2, name: 'auckland'}).save()
await db.query(`select id, name from people`)
```
Say you need to use a new query in your tests. You might want to see if the test schema supports it:
```js
await swormSchema.validateQuery(`
select p.name, o.name as orgName
from people p inner join
organisations o on p.org_id = o.id
`)
```
which will output:
```json
{
"message": "Incompatible",
"missing": {
"people": {
"org_id": {
"type": "unknown"
}
},
"organisations": {
"name": {
"type": "unknown"
},
"id": {
"type": "unknown"
}
}
}
}
```
You might want to clean up the data afterwards:
```js
await swormSchema.clean()
```
Or if you just want to get rid of the whole database:
```js
await swormSchema.drop()
```
## We're Hiring!
Featurist provides full stack, feature driven development teams. Want to join us? Check out [our career opportunities](https://www.featurist.co.uk/careers/).