Skip to content

Commit

Permalink
Add PostgreSQL built-in range types (#67)
Browse files Browse the repository at this point in the history 
* Update in readme features section
  • Loading branch information
@abogoyavlensky
abogoyavlensky authored Nov 19, 2023
1 parent 1cec9be commit 51e821d
Show file tree
Hide file tree
Showing 5 changed files with 273 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and create database schema migrations automatically based on changes to the mode
- **migrate** db schema to any migration in forward or backward *[:construction: under development]* directions;
- view actual SQL or human-readable description for a migration;
- optionally add a custom SQL migration for specific cases;
- use with PostgreSQL *[:construction: others are under development]*;
- use with PostgreSQL.

## State

Expand Down
15 changes: 14 additions & 1 deletion src/automigrate/fields.clj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,20 @@
:tsquery
:tsvector
:txid_snapshot
:xml}))
:xml
; Range types
:int4range
:int4multirange
:int8range
:int8multirange
:numrange
:nummultirange
:tsrange
:tsmultirange
:tstzrange
:tstzmultirange
:daterange
:datemultirange}))


(defn- field-type-dispatch
Expand Down
251 changes: 251 additions & 0 deletions test/automigrate/fields_range_test.clj
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
(ns automigrate.fields-range-test
(:require [clojure.string :as str]
[clojure.test :refer :all]
[automigrate.testing-util :as test-util]
[automigrate.testing-config :as config]))


(use-fixtures :each
(test-util/with-drop-tables config/DATABASE-CONN)
(test-util/with-delete-dir config/MIGRATIONS-DIR))


(deftest ^:eftest/slow test-fields-range-create-table-ok
(doseq [{:keys [field-type]}
; interval
[{:field-type :int4range}
{:field-type :int4multirange}
{:field-type :int8range}
{:field-type :int8multirange}
{:field-type :numrange}
{:field-type :nummultirange}
{:field-type :tsrange}
{:field-type :tsmultirange}
{:field-type :tstzrange}
{:field-type :tstzmultirange}
{:field-type :daterange}
{:field-type :datemultirange}]
:let [type-name (name field-type)]]
(test-util/drop-all-tables config/DATABASE-CONN)
(test-util/delete-recursively config/MIGRATIONS-DIR)

(testing "check generated actions, queries edn and sql from all actions"
(is (= {:new-actions (list {:action :create-table
:fields {:thing {:type field-type}}
:model-name :account})
:q-edn [{:create-table [:account]
:with-columns
[(list :thing field-type)]}]
:q-sql [[(format "CREATE TABLE account (thing %s)"
(str/upper-case type-name))]]}
(test-util/perform-make-and-migrate!
{:jdbc-url config/DATABASE-CONN
:existing-actions []
:existing-models {:account
{:fields [[:thing field-type]]}}})))

(testing "check actual db changes"
(testing "test actual db schema after applying the migration"
(is (= [{:character_maximum_length nil
:column_default nil
:column_name "thing"
:data_type type-name
:udt_name type-name
:is_nullable "YES"
:table_name "account"}]
(test-util/get-table-schema-from-db
config/DATABASE-CONN
"account"))))))))


(deftest ^:eftest/slow test-fields-range-alter-column-ok
(doseq [{:keys [field-type]} [{:field-type :int4range}
{:field-type :int4multirange}
{:field-type :int8range}
{:field-type :int8multirange}
{:field-type :numrange}
{:field-type :nummultirange}
{:field-type :tsrange}
{:field-type :tsmultirange}
{:field-type :tstzrange}
{:field-type :tstzmultirange}
{:field-type :daterange}
{:field-type :datemultirange}]
:let [type-name (name field-type)
type-name-up (str/upper-case type-name)]]
(test-util/drop-all-tables config/DATABASE-CONN)
(test-util/delete-recursively config/MIGRATIONS-DIR)

(testing "check generated actions, queries edn and sql from all actions"
(is (= {:new-actions (list {:action :alter-column
:changes {:type {:from :char
:to field-type}}
:field-name :thing
:model-name :account
:options {:type field-type}})
:q-edn [{:create-table [:account]
:with-columns ['(:id :serial)]}
{:add-column (list :thing :char)
:alter-table :account}
{:alter-table (list :account
{:alter-column
(list :thing :type field-type
:using [:raw "thing"] [:raw "::"]
field-type)})}]
:q-sql [["CREATE TABLE account (id SERIAL)"]
[(format "ALTER TABLE account ADD COLUMN thing CHAR")]
[(format "ALTER TABLE account ALTER COLUMN thing TYPE %s USING thing :: %s"
type-name-up type-name-up)]]}
(test-util/perform-make-and-migrate!
{:jdbc-url config/DATABASE-CONN
:existing-actions [{:action :create-table
:fields {:id {:type :serial}}
:model-name :account}
{:action :add-column
:field-name :thing
:model-name :account
:options {:type :char}}]
:existing-models {:account
{:fields [[:id :serial]
[:thing field-type]]}}})))

(testing "check actual db changes"
(testing "test actual db schema after applying the migration"
(is (= [{:character_maximum_length nil
:column_default "nextval('account_id_seq'::regclass)"
:column_name "id"
:data_type "integer"
:udt_name "int4"
:is_nullable "NO"
:table_name "account"}
{:character_maximum_length nil
:column_default nil
:column_name "thing"
:data_type type-name
:udt_name type-name
:is_nullable "YES"
:table_name "account"}]
(test-util/get-table-schema-from-db
config/DATABASE-CONN
"account"))))))))


(deftest ^:eftest/slow test-fields-range-add-column-ok
(doseq [{:keys [field-type]} [{:field-type :int4range}
{:field-type :int4multirange}
{:field-type :int8range}
{:field-type :int8multirange}
{:field-type :numrange}
{:field-type :nummultirange}
{:field-type :tsrange}
{:field-type :tsmultirange}
{:field-type :tstzrange}
{:field-type :tstzmultirange}
{:field-type :daterange}
{:field-type :datemultirange}]
:let [type-name (name (if (vector? field-type)
(first field-type)
field-type))
type-name-up (str/upper-case type-name)]]
(test-util/drop-all-tables config/DATABASE-CONN)
(test-util/delete-recursively config/MIGRATIONS-DIR)

(testing "check generated actions, queries edn and sql from all actions"
(is (= {:new-actions (list {:action :add-column
:field-name :thing
:model-name :account
:options {:type field-type}})
:q-edn [{:create-table [:account]
:with-columns ['(:id :serial)]}
{:add-column (list :thing
(if (vector? field-type)
[:raw type-name-up]
field-type))
:alter-table :account}]
:q-sql [["CREATE TABLE account (id SERIAL)"]
[(format "ALTER TABLE account ADD COLUMN thing %s"
type-name-up)]]}
(test-util/perform-make-and-migrate!
{:jdbc-url config/DATABASE-CONN
:existing-actions [{:action :create-table
:fields {:id {:type :serial}}
:model-name :account}]
:existing-models {:account
{:fields [[:id :serial]
[:thing field-type]]}}})))

(testing "check actual db changes"
(testing "test actual db schema after applying the migration"
(is (= [{:character_maximum_length nil
:column_default "nextval('account_id_seq'::regclass)"
:column_name "id"
:data_type "integer"
:udt_name "int4"
:is_nullable "NO"
:table_name "account"}
{:character_maximum_length nil
:column_default nil
:column_name "thing"
:data_type type-name
:udt_name type-name
:is_nullable "YES"
:table_name "account"}]
(test-util/get-table-schema-from-db
config/DATABASE-CONN
"account"))))))))


(deftest ^:eftest/slow test-fields-range-drop-column-ok
(doseq [{:keys [field-type]} [{:field-type :int4range}
{:field-type :int4multirange}
{:field-type :int8range}
{:field-type :int8multirange}
{:field-type :numrange}
{:field-type :nummultirange}
{:field-type :tsrange}
{:field-type :tsmultirange}
{:field-type :tstzrange}
{:field-type :tstzmultirange}
{:field-type :daterange}
{:field-type :datemultirange}]
:let [type-name (name field-type)
type-name-up (str/upper-case type-name)]]
(test-util/drop-all-tables config/DATABASE-CONN)
(test-util/delete-recursively config/MIGRATIONS-DIR)

(testing "check generated actions, queries edn and sql from all actions"
(is (= {:new-actions (list {:action :drop-column
:field-name :thing
:model-name :account})
:q-edn [{:create-table [:account]
:with-columns ['(:id :serial)
(list :thing
(if (vector? field-type)
[:raw type-name-up]
field-type))]}
{:drop-column :thing
:alter-table :account}]
:q-sql [[(format "CREATE TABLE account (id SERIAL, thing %s)"
type-name-up)]
["ALTER TABLE account DROP COLUMN thing"]]}
(test-util/perform-make-and-migrate!
{:jdbc-url config/DATABASE-CONN
:existing-actions [{:action :create-table
:fields {:id {:type :serial}
:thing {:type field-type}}
:model-name :account}]
:existing-models {:account
{:fields [[:id :serial]]}}})))

(testing "check actual db changes"
(testing "test actual db schema after applying the migration"
(is (= [{:character_maximum_length nil
:column_default "nextval('account_id_seq'::regclass)"
:column_name "id"
:data_type "integer"
:udt_name "int4"
:is_nullable "NO"
:table_name "account"}]
(test-util/get-table-schema-from-db
config/DATABASE-CONN
"account"))))))))
12 changes: 6 additions & 6 deletions test/automigrate/fields_time_test.clj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,11 +226,11 @@


(deftest ^:eftest/slow test-fields-time-alter-column-to-array-ok
(doseq [{:keys [field-type data-type]} [{:field-type :interval}
{:field-type :time}
{:field-type :timetz}
{:field-type :timestamp}
{:field-type :timestamptz}]
(doseq [{:keys [field-type]} [{:field-type :interval}
{:field-type :time}
{:field-type :timetz}
{:field-type :timestamp}
{:field-type :timestamptz}]
:let [type-name (name field-type)
type-name-up (str/upper-case type-name)]]
(test-util/drop-all-tables config/DATABASE-CONN)
Expand Down Expand Up @@ -503,7 +503,7 @@
(is (= [] (#'migrations/make-migration* "" []))))))


(deftest test-fields-time-uses-existing-enum-type
(deftest test-fields-time-error
(doseq [{:keys [field-type expected-output]}
[{:field-type [:interval]
:expected-output (str "-- MODEL ERROR -------------------------------------\n\n"
Expand Down
2 changes: 1 addition & 1 deletion test/automigrate/migrations_sql_test.clj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
(.getName (last files)))))))


(deftest test-migrate-sql-migration-ok
(deftest ^:eftest/slow test-migrate-sql-migration-ok
(core/make {:models-file (str config/MODELS-DIR "feed_basic.edn")
:migrations-dir config/MIGRATIONS-DIR})
(core/make {:models-file (str config/MODELS-DIR "feed_basic.edn")
Expand Down

0 comments on commit 51e821d

Please sign in to comment.