@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 includes all migrations under the Pg Types, Pg Operator Classes, 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.

Required Permissions

To add the framestamp_range canonical, function, we must directly add it to the framestamp_range type in the pg_catalog table. In most databases, this will require elevated permissions. See the inject_canonical_function/0 for more information on why this is required.

You can choose to skip this step if you wish by setting the inject_canonical? op to false, but operations that require discreet nudging of in-and-out points will not return correct results, and ranges with different upper/lower bound types will not be comparable.

types-created

Types Created

Calling this macro creates the following type definitions:

CREATE TYPE framestamp_range AS RANGE (
  subtype = framestamp,
  subtype_diff = framestamp_range_private.subtype_diff
  canonical = framestamp_range_private.canonical
);

CREATE TYPE framestamp_fastrange AS RANGE (
  subtype = double precision,
  subtype_diff = float8mi
);

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: [
    framestamp_range: [
      functions_schema: :framestamp_range,
      functions_prefix: "framestamp_range"
    ]
  ]

Option definitions are as follows:

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

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

examples

Examples

defmodule MyMigration do
  use Ecto.Migration

  alias Vtc.Ecto.Postgres.PgFramestamp
  require PgFramestamp.Migrations

  def change do
    PgFramestamp.Range.Migrations.run()
  end
end