Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pyramation/skitch
build versioned PostgreSQL apps fast
https://github.com/pyramation/skitch
Last synced: about 2 months ago
JSON representation
build versioned PostgreSQL apps fast
- Host: GitHub
- URL: https://github.com/pyramation/skitch
- Owner: pyramation
- License: mit
- Created: 2018-09-24T22:44:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-01T01:36:03.000Z (over 4 years ago)
- Last Synced: 2024-10-11T08:14:56.579Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 11.1 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - pyramation/skitch - build versioned PostgreSQL apps fast (TypeScript)
README
# skitch
[](https://travis-ci.org/AirPageInc/skitch)
Create PostgreSQL sql code quickly and in a streamlined, versioned workflow.
`skitch` is a wrapper around `sqitch` to enable a sane workflow for sane database management.
* write and deploy extensions that can be installed with `CREATE EXTENSION`
* optionally deploy same source as `sqitch` modules (since some managed db providers don't allow custom extensions)
* write/deploy a project full of many `sqitch` modules that cross-reference each other using dependency resolution for running deploy command in proper order, etc
* pulling modules down (currently via npm) to make re-usability super easy
## installation
#### Install `psql`
Install `psql` without actually running the database. On mac you can use
`brew install libpq`
Or you can install the full-blown postgres locally, but it is recommended that you shut the service down. You'll be using `psql` to connect to the postgres that runs inside of a docker container.
#### Install sqitch
https://sqitch.org/
mac users can use brew: https://github.com/sqitchers/homebrew-sqitch
#### Install the Template library from http://www.tt2.org/
```sh
sudo cpan Template
```
#### Install `skitch` globally
```sh
npm install -g skitch
```
#### Get the verification utils
https://github.com/pyramation/pg-utils
## getting started
Initialize a project
```sh
skitch init --bare
skitch install
```
Now you should have a `packages/` folder
```sh
cd packages/
mkdir myfirstmodule
cd myfirstmodule/
skitch init
```
Now you can create some `sql` using `sqitch`!
```sh
skitch generate schema
skitch generate table
```
Deploy recursively, using all the required modules!
```sh
skitch deploy --createdb --recursive
```
## testing
To create a test, first cd into a sqitch module
```sh
cd packages/myfirstmodule
skitch maketest
```
Then you can use `jest` via `yarn` to test your logic.
```sh
yarn test:watch
```
## what's different
* interactive shell
* naming conventions
* utility functions to create verify/revert functions for most types
* bundled with templates for most common things:
```
column
extension
fixture
foreignKey
fullPolicy
grantAllTables
grantExecute
grantRole
grantSchema
grantTable
index
policy
procedure
role
rowLevelSecurity
schema
table
timestamps
trigger
type
uniqueIndex
utility
view
```
## bundle an npm module
You can install an npm module and then bundle it for `plv8`
```sh
yarn add my-awesome-npm-module
skitch bundle my-awesome-npm-module awesomeThing
```
## Install some existing packages
```sh
skitch install skitch-extension-verify
skitch install skitch-extension-jobs
```