View Source Vtc.Ecto.Postgres.PgFramerate.Migrations (vtc v0.10.8)

Migrations for adding framerate types, functions and constraints to a Postgres database.

Link to this section Summary

Full

Adds raw SQL queries to a migration for creating the database types, associated functions, casts, operators, and operator families.

PgConstraints

Creates basic constraints for a PgFramerate database field.

PgTypes

Creates schemas to act as namespaces for rational functions

Adds framerate composite type.

Adds framerate_tgs enum type.

Link to this section Full

@spec create_all() :: :ok

Adds raw SQL queries to a migration for creating the database types, associated functions, casts, operators, and operator families.

Safe to run multiple times when new functionality is added in updates to this library. Existing values will be skipped.

types-created

Types Created

Calling this macro creates the following type definitions:

CREATE TYPE framerate_tags AS ENUM (
  'drop',
  'non_drop'
);
CREATE TYPE framerate AS (
  playback rational,
  tags framerate_tags[]
);

schemas-created

Schemas Created

Up to two schemas are created as detailed by the Configuring Database Objects section below.

configuring-database-objects

Configuring Database Objects

To change where supporting functions are created, add the following to your Repo confiugration:

config :vtc, Vtc.Test.Support.Repo,
  adapter: Ecto.Adapters.Postgres,
  ...
  vtc: [
    pg_framerate: [
      functions_schema: :framerate,
      functions_private_schema: :framerate_private,
      functions_prefix: "framerate"
    ]
  ]

Option definitions are as follows:

  • functions_schema: The schema for "public" functions that will have backwards compatibility guarantees and application code support. Default: :public.

  • functions_private_schema: The schema for for developer-only "private" functions that support the functions in the "framerate" schema. Will NOT have backwards compatibility guarantees NOR application code support. Default: :public.

  • functions_prefix: A prefix to add before all functions. Defaults to "framerate" for any function created in the "public" schema, and "" otherwise.

examples

Examples

defmodule MyMigration do
  use Ecto.Migration

  alias Vtc.Ecto.Postgres.PgFramerate
  require PgFramerate.Migrations

  def change do
    PgFramerate.Migrations.create_all()
  end
end

Link to this section PgConstraints

Link to this function

create_field_constraints(table, field_name)

View Source
@spec create_field_constraints(atom(), atom()) :: :ok

Creates basic constraints for a PgFramerate database field.

constraints-created

Constraints created:

  • {field_name}_positive: Checks that the playback speed is positive.

  • {field_name}_ntsc_tags: Checks that only drop or non_drop is set.

examples

Examples

create table("my_table", primary_key: false) do
  add(:id, :uuid, primary_key: true, null: false)
  add(:a, PgFramerate.type())
  add(:b, PgFramerate.type())
end

PgRational.migration_add_field_constraints(:my_table, :a)
PgRational.migration_add_field_constraints(:my_table, :b)

Link to this section PgTypes

Link to this function

create_function_schemas()

View Source
@spec create_function_schemas() :: :ok

Creates schemas to act as namespaces for rational functions:

  • rational: for user-facing "public" functions that will have backwards compatibility guarantees and application code support.

  • rational_private: for developer-only "private" functions that support the functions in the "rational" schema. Will NOT havr backwards compatibility guarantees NOR application code support.

@spec create_type_framerate() :: :ok

Adds framerate composite type.

Link to this function

create_type_framerate_tags()

View Source
@spec create_type_framerate_tags() :: :ok

Adds framerate_tgs enum type.