@spec run(include: Keyword.t(atom()), exclude: Keyword.t(atom())) :: :ok

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

This migration included all migrations under the Pg Types, Pg Operators, Pg Functions, and Pg Private Functions, headings.

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

Individual migration functions return raw sql commands in an {up_command, down_command} tuple.

options

Options

• include: A list of migration functions to include. If not set, all sub-migrations will be included.

• exclude: A list of migration functions to exclude. If not set, no sub-migrations will be excluded.

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 configuration:

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

Option definitions are as follows:

• functions_schema: The postgres schema to store framerate-related custom functions.

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

private-functions

Private Functions

Some custom function names are prefaced with __private__. These functions should not be called by end-users, as they are not subject to any API stability guarantees.

examples

Examples

defmodule MyMigration do
  use Ecto.Migration

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

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