Files
speckle-server/modules/core/migrations/001-streams.js
T

119 lines
5.0 KiB
JavaScript

'use strict'
// Knex table migrations
exports.up = async knex => {
await knex.raw( 'CREATE EXTENSION IF NOT EXISTS "pgcrypto"' )
await knex.raw( 'CREATE EXTENSION IF NOT EXISTS "ltree"' )
// Streams Table
await knex.schema.createTable( 'streams', table => {
table.text( 'id' ).unique( ).primary( )
table.text( 'name' )
table.text( 'description' )
table.boolean( 'isPublic' ).defaultTo( true )
table.text( 'cloned_from' ).references( 'id' ).inTable( 'streams' )
table.timestamp( 'created_at' ).defaultTo( knex.fn.now( ) )
table.timestamp( 'updated_at' ).defaultTo( knex.fn.now( ) )
// table.unique( [ 'owner_id', 'name' ] )
} )
// creates an enum type for stream acl roles.
await knex.raw( `
DO $$
BEGIN
IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'speckle_acl_role_type') THEN
CREATE TYPE speckle_acl_role_type AS ENUM( 'owner', 'admin', 'write', 'read' );
END IF;
END$$;
` )
await knex.schema.createTable( 'stream_acl', table => {
table.text( 'user_id' ).references( 'id' ).inTable( 'users' ).notNullable( )
table.text( 'resource_id' ).references( 'id' ).inTable( 'streams' ).notNullable( )
table.primary( [ 'user_id', 'resource_id' ] )
table.unique( [ 'user_id', 'resource_id' ] )
table.specificType( 'role', 'speckle_acl_role_type' ).defaultTo( 'write' )
} )
// Objects Table
await knex.schema.createTable( 'objects', table => {
table.text( 'hash' ).primary( )
table.text( 'speckle_type' ).defaultTo( 'Base' ).notNullable( )
table.text( 'applicationId' )
table.jsonb( 'data' )
table.text( 'author' ).references( 'id' ).inTable( 'users' )
table.timestamp( 'created_at' ).defaultTo( knex.fn.now( ) )
table.index( [ 'speckle_type' ], 'type_index' )
} )
await knex.schema.createTable( 'object_tree_refs', table => {
table.increments( 'id' )
table.text( 'parent' )
table.specificType( 'path', 'ltree' )
} )
await knex.raw( `CREATE INDEX tree_path_idx ON object_tree_refs USING gist(path)` )
// Sets a trigger to generate the hash of objects if not present.
// File
let hashTriggerObjects = require( './helperFunctions' ).hashTriggerGenerator( 'objects', 'hash' )
await knex.raw( hashTriggerObjects )
// creates an enum type for db references.
await knex.raw( `
DO $$
BEGIN
IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'speckle_reference_type') THEN
CREATE TYPE speckle_reference_type AS ENUM( 'branch', 'tag' );
END IF;
END$$;
` )
// Reference table. A reference can be a branch or a tag.
await knex.schema.createTable( 'references', table => {
table.uuid( 'id' ).defaultTo( knex.raw( 'gen_random_uuid()' ) ).unique( ).primary( )
table.text( 'stream_id' ).references( 'id' ).inTable( 'streams' ).notNullable( )
table.text( 'author' ).references( 'id' ).inTable( 'users' )
table.text( 'name' )
table.specificType( 'type', 'speckle_reference_type' ).defaultTo( 'branch' )
table.text( 'description' )
// (Sparse) Only populated for tags, which hold one commit.
table.text( 'commit_id' ).references( 'hash' ).inTable( 'objects' )
table.timestamp( 'created_at' ).defaultTo( knex.fn.now( ) )
table.timestamp( 'updatedAt' ).defaultTo( knex.fn.now( ) )
table.unique( [ 'stream_id', 'name' ] )
} )
// Junction Table Branches >- -< Commits
// Note: Branches >- -< Commits is a many-to-many relationship (one commit can belong to multiple branches, one branch can have multiple commits)
await knex.schema.createTable( 'branch_commits', table => {
table.uuid( 'branch_id' ).references( 'id' ).inTable( 'references' ).notNullable( )
table.text( 'commit_id' ).references( 'hash' ).inTable( 'objects' ).notNullable( )
table.primary( [ 'branch_id', 'commit_id' ] )
} )
// Flat table to store all commits to this stream, regardless of branch.
// Optional, might be removed as you can get all the commits from each branch...
await knex.schema.createTable( 'stream_commits', table => {
table.text( 'stream_id' ).references( 'id' ).inTable( 'streams' ).notNullable( )
table.text( 'commit_id' ).references( 'hash' ).inTable( 'objects' ).notNullable( )
} )
await knex.schema.createTable( 'user_commits', table => {
table.text( 'owner_id' ).references( 'id' ).inTable( 'users' ).notNullable( )
table.text( 'commit_id' ).references( 'hash' ).inTable( 'objects' )
} )
}
exports.down = async knex => {
await knex.schema.dropTableIfExists( 'stream_acl' )
await knex.schema.dropTableIfExists( 'stream_commits' )
await knex.schema.dropTableIfExists( 'branch_commits' )
await knex.schema.dropTableIfExists( 'user_commits' )
await knex.schema.dropTableIfExists( 'references' )
await knex.schema.dropTableIfExists( 'object_tree_refs' )
await knex.schema.dropTableIfExists( 'objects' )
await knex.schema.dropTableIfExists( 'streams' )
await knex.raw( `DROP TYPE IF EXISTS speckle_reference_type ` )
await knex.raw( `DROP TYPE IF EXISTS speckle_acl_role_type ` )
}