activefacts-compositions 1.9.17 → 1.9.18

data/lib/activefacts/generator/traits/sql/mysql.rb

@@ -0,0 +1,280 @@
+#
+#       ActiveFacts MySQL Traits
+#
+# Copyright (c) 2009-2016 Clifford Heath. Read the LICENSE file.
+#
+# Reserved words gathered from:
+# https://dev.mysql.com/doc/refman/5.7/en/keywords.html
+#
+require 'digest/sha1'
+require 'activefacts/metamodel'
+require 'activefacts/compositions'
+require 'activefacts/generator/traits/sql'
+
+module ActiveFacts
+  module Generators
+    module Traits
+      # Options are comma or space separated:
+      # * underscore 
+      module SQL
+        module MySQL
+          include Traits::SQL
+
+          def options
+            super.merge({
+              # no: [String, "no new options defined here"]
+            })
+          end
+
+          def defaults_and_options options
+            super
+          end
+
+          def process_options options
+            super
+          end
+
+          def data_type_context_class
+            MySQLDataTypeContext
+          end
+
+          # See https://dev.mysql.com/doc/refman/5.7/en/identifiers.html
+          def table_name_max
+            64
+          end
+
+          def column_name_max
+            64
+          end
+
+          def index_name_max
+            64
+          end
+
+          def schema_name_max
+            64
+          end
+
+          def schema_prefix
+            ''
+          end
+
+          def index_kind(index)
+            super
+          end
+
+          def choose_sql_type(type_name, value_constraint, component, options)
+            case MM::DataType.intrinsic_type(type_name)
+            when MM::DataType::TYPE_Integer
+              # The :auto_assign key is set for auto-assigned types, but with a nil value in foreign keys
+              if options.has_key?(:auto_assign)
+                options[:default] = ' AUTO_INCREMENT' if options[:auto_assign]
+                'BIGINT'
+              else
+                super
+              end
+
+            when MM::DataType::TYPE_Money
+              'DECIMAL'
+
+            when MM::DataType::TYPE_DateTime
+              'DATETIME'
+
+            when MM::DataType::TYPE_Timestamp
+              'DATETIME'
+
+            when MM::DataType::TYPE_Binary
+              case binary_surrogate(type_name, value_constraint, options)
+              when :guid_fk             # A GUID surrogate that's auto-assigned elsewhere
+                options[:length] = 16
+              when :guid                # A GUID
+                options[:length] = 16
+                options[:default] = " DEFAULT UNHEX(REPLACE(UUID(),'-',''))"
+              when :hash                # A hash of the natural key
+                options[:length] = 20   # Assuming SHA-1. SHA-256 would need 32 bytes
+                leaves = component.root.natural_index.all_index_field.map(&:component)
+                # NDB Only, not InnoDB:
+                # options[:default] = " GENERATED ALWAYS AS (#{hash(concatenate(coalesce(as_text(safe_column_exprs(leaves)))))}) STORED"
+                options[:delayed] = trigger_hash_assignment(component, component.root.natural_index.all_index_field.map(&:component))
+              else                      # Not a surrogate
+                # MySQL has various non-standard blob types also
+              end
+              'BINARY'
+
+            else
+              super
+            end
+          end
+
+          # Return an array of SQL statements that arrange for the hash_field
+          # to be populated with a hash of the values of the leaves.
+          def trigger_hash_assignment hash_field, leaves
+            table_name = safe_table_name(hash_field.root)
+            trigger_function = escape('assign_'+column_name(hash_field), 128)
+            [
+              %Q{
+                CREATE TRIGGER #{trigger_function} BEFORE INSERT ON #{table_name}
+                FOR EACH ROW SET #{safe_column_name(hash_field)} = #{
+                  hash(concatenate(coalesce(as_text(safe_column_exprs(leaves, 'NEW')))))
+              }}.unindent
+            ]
+          end
+
+          # Some or all of the SQL expressions may have non-text values.
+          # Return an SQL expression that coerces them to text.
+          def as_text exprs
+            return exprs.map{|e| as_text(e)} if Array === exprs
+
+            Expression.new("CAST(#{exprs} AS CHAR)", MM::DataType::TYPE_String, exprs.is_mandatory)
+          end
+
+          # Return an SQL expression that concatenates the given expressions (which must yield a string type)
+          def concatenate expressions
+            Expression.new(
+              "CONCAT('|', #{expressions.map(&:to_s)*', '})",
+              MM::DataType::TYPE_String,
+              true
+            )
+          end
+
+          # Return an expression that yields a hash of the given expression
+          # SHA1 produces 40 hexadecimal digits
+          def hash expr, algo = nil
+            Expression.new("UNHEX(SHA1(#{expr}))", MM::DataType::TYPE_Binary, expr.is_mandatory)
+          end
+
+          # Reserved words cannot be used anywhere without quoting.
+          # Keywords have existing definitions, so should not be used without quoting.
+          # Both lists here are added to the supertype's lists
+          def reserved_words
+            @mysql_reserved_words ||= %w{
+              ACCESSIBLE ANALYZE CHANGE DATABASE DATABASES DAY_HOUR
+              DAY_MICROSECOND DAY_MINUTE DAY_SECOND DELAYED DISTINCTROW
+              DIV DUAL ENCLOSED ESCAPED EXPLAIN FLOAT4 FLOAT8 FORCE
+              FULLTEXT HIGH_PRIORITY HOUR_MICROSECOND HOUR_MINUTE
+              HOUR_SECOND INDEX INFILE INT1 INT2 INT3 INT4 INT8
+              IO_AFTER_GTIDS IO_BEFORE_GTIDS KEYS KILL LINEAR LINES
+              LOAD LOCK LONG LONGBLOB LONGTEXT LOW_PRIORITY MASTER_BIND
+              MASTER_SSL_VERIFY_SERVER_CERT MEDIUMBLOB MEDIUMINT
+              MEDIUMTEXT MIDDLEINT MINUTE_MICROSECOND MINUTE_SECOND
+              NO_WRITE_TO_BINLOG OPTIMIZE OPTIMIZER_COSTS OPTIONALLY
+              OUTFILE PURGE READ_WRITE REGEXP RENAME REPLACE REQUIRE
+              RLIKE SCHEMAS SECOND_MICROSECOND SEPARATOR SHOW SPATIAL
+              SQL_BIG_RESULT SQL_CALC_FOUND_ROWS SQL_SMALL_RESULT SSL
+              STARTING STORED STRAIGHT_JOIN TERMINATED TINYBLOB TINYINT
+              TINYTEXT UNLOCK UNSIGNED USE UTC_DATE UTC_TIME UTC_TIMESTAMP
+              VARCHARACTER VIRTUAL XOR YEAR_MONTH ZEROFILL _FILENAME
+            }
+            super + @mysql_reserved_words
+          end
+
+          def key_words
+            # These keywords should not be used for columns or tables:
+            @mysql_key_words ||= %w{
+              ACCOUNT AGAINST AGGREGATE ALGORITHM ANALYSE ASCII
+              AUTOEXTEND_SIZE AUTO_INCREMENT AVG_ROW_LENGTH BACKUP
+              BINLOG BLOCK BOOL BTREE BYTE CACHE CHANGED CHANNEL
+              CHARSET CHECKSUM CIPHER CLIENT CODE COLUMN_FORMAT COMMENT
+              COMPACT COMPLETION COMPRESSED COMPRESSION CONCURRENT
+              CONSISTENT CONTEXT CPU DATAFILE DATETIME DEFAULT_AUTH
+              DELAY_KEY_WRITE DES_KEY_FILE DIRECTORY DISABLE DISCARD
+              DISK DUMPFILE DUPLICATE ENABLE ENCRYPTION ENDS ENGINE
+              ENGINES ENUM ERROR ERRORS EVENT EVENTS EXCHANGE EXPANSION
+              EXPIRE EXPORT EXTENDED EXTENT_SIZE FAST FAULTS FIELDS
+              FILE_BLOCK_SIZE FIXED FLUSH FOLLOWS FORMAT GEOMETRY
+              GEOMETRYCOLLECTION GET_FORMAT GRANTS GROUP_REPLICATION
+              HASH HELP HOST HOSTS IDENTIFIED IGNORE_SERVER_IDS INDEXES
+              INITIAL_SIZE INSERT_METHOD INSTALL IO IO_THREAD IPC
+              ISSUER JSON KEY_BLOCK_SIZE LEAVES LESS LINESTRING LIST
+              LOCKS LOGFILE LOGS MASTER MASTER_AUTO_POSITION
+              MASTER_CONNECT_RETRY MASTER_DELAY MASTER_HEARTBEAT_PERIOD
+              MASTER_HOST MASTER_LOG_FILE MASTER_LOG_POS MASTER_PASSWORD
+              MASTER_PORT MASTER_RETRY_COUNT MASTER_SERVER_ID MASTER_SSL
+              MASTER_SSL_CA MASTER_SSL_CAPATH MASTER_SSL_CERT
+              MASTER_SSL_CIPHER MASTER_SSL_CRL MASTER_SSL_CRLPATH
+              MASTER_SSL_KEY MASTER_TLS_VERSION MASTER_USER
+              MAX_CONNECTIONS_PER_HOUR MAX_QUERIES_PER_HOUR MAX_ROWS
+              MAX_SIZE MAX_STATEMENT_TIME MAX_UPDATES_PER_HOUR
+              MAX_USER_CONNECTIONS MEDIUM MEMORY MICROSECOND MIGRATE
+              MIN_ROWS MODE MODIFY MULTILINESTRING MULTIPOINT
+              MULTIPOLYGON MUTEX MYSQL_ERRNO NDB NDBCLUSTER NEVER
+              NODEGROUP NONBLOCKING NO_WAIT NVARCHAR OLD_PASSWORD ONE
+              OWNER PACK_KEYS PAGE PARSER PARSE_GCOL_EXPR PARTITIONING
+              PARTITIONS PASSWORD PHASE PLUGIN PLUGINS PLUGIN_DIR
+              POINT POLYGON PORT PREV PROCESSLIST PROFILE PROFILES
+              PROXY QUARTER QUERY QUICK READ_ONLY REBUILD RECOVER
+              REDOFILE REDO_BUFFER_SIZE REDUNDANT RELAY RELAYLOG
+              RELAY_LOG_FILE RELAY_LOG_POS RELAY_THREAD RELOAD REMOVE
+              REORGANIZE REPAIR REPLICATE_DO_DB REPLICATE_DO_TABLE
+              REPLICATE_IGNORE_DB REPLICATE_IGNORE_TABLE REPLICATE_REWRITE_DB
+              REPLICATE_WILD_DO_TABLE REPLICATE_WILD_IGNORE_TABLE
+              REPLICATION RESET RESUME REVERSE ROTATE ROW_FORMAT RTREE
+              SCHEDULE SERIAL SHARE SHUTDOWN SIGNED SLAVE SLOW SNAPSHOT
+              SOCKET SONAME SOUNDS SQL_AFTER_GTIDS SQL_AFTER_MTS_GAPS
+              SQL_BEFORE_GTIDS SQL_BUFFER_RESULT SQL_CACHE SQL_NO_CACHE
+              SQL_THREAD SQL_TSI_DAY SQL_TSI_HOUR SQL_TSI_MINUTE
+              SQL_TSI_MONTH SQL_TSI_QUARTER SQL_TSI_SECOND SQL_TSI_WEEK
+              SQL_TSI_YEAR STACKED STARTS STATS_AUTO_RECALC
+              STATS_PERSISTENT STATS_SAMPLE_PAGES STATUS STOP STORAGE
+              STRING SUBJECT SUBPARTITION SUBPARTITIONS SUPER SUSPEND
+              SWAPS SWITCHES TABLES TABLESPACE TABLE_CHECKSUM TEMPTABLE
+              TEXT THAN TIMESTAMPADD TIMESTAMPDIFF TRIGGERS TYPES
+              UNDEFINED UNDOFILE UNDO_BUFFER_SIZE UNICODE UNINSTALL
+              UPGRADE USER_RESOURCES USE_FRM VALIDATION VARIABLES
+              WAIT WARNINGS WEEK WEIGHT_STRING X509 XA XID
+            }
+            super + @mysql_key_words
+          end
+
+          def open_escape
+            '`'
+          end
+
+          def close_escape
+            '`'
+          end
+
+          def index_kind(index)
+            ''
+          end
+
+          class MySQLDataTypeContext < SQLDataTypeContext
+            def integer_ranges
+              [
+                ['TINYINT', -2**7, 2**7-1],
+                ['TINYINT UNSIGNED', 0, 2**8-1], 
+                ['MEDIUMINT', -2**23, 2**23-1], 
+              ] + super
+            end
+
+            # MySQL also has a BIT type, but you can specify a size up to BIT(64). This is better.
+            def boolean_type
+              'BOOLEAN'     # Which is a synonym for TINYINT(1), stores 0 or 1
+            end
+
+            def boolean_expr safe_column_name
+              "#{safe_column_name} = 1"
+            end
+
+            def default_char_type
+              (@unicode ? 'N' : '') +
+              'CHAR'
+            end
+
+            def default_varchar_type
+              (@unicode ? 'N' : '') +
+              'VARCHAR'
+            end
+
+            def date_time_type
+              # MySQL also has TIMESTAMP values, but those run from 1970/01/01 through 2038/01/19
+              # DATETIME runs from 1000/01/01 through 9999/01/01
+              'DATETIME'
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/activefacts/generator/traits/sql/oracle.rb

@@ -0,0 +1,265 @@
+#
+#       ActiveFacts Oracle SQL Traits
+#
+# Copyright (c) 2009-2016 Clifford Heath. Read the LICENSE file.
+#
+# Reserved words gathered from:
+# https://docs.oracle.com/cd/B28359_01/appdev.111/b31231/appb.htm
+#
+require 'digest/sha1'
+require 'activefacts/metamodel'
+require 'activefacts/compositions'
+require 'activefacts/generator/traits/sql'
+
+module ActiveFacts
+  module Generators
+    module Traits
+      # Options are comma or space separated:
+      # * underscore 
+      module SQL
+        module Oracle
+          include Traits::SQL
+
+          # Options available in this flavour of SQL
+          def options
+            super.merge({
+              # no: [String, "no new options defined here"]
+            })
+          end
+
+          # The options parameter overrides any default options set by sub-traits
+          def defaults_and_options options
+            {'tables' => 'shout', 'columns' => 'shout'}.merge(options)
+          end
+
+          def process_options options
+            super
+          end
+
+          def data_type_context_class
+            OracleDataTypeContext
+          end
+
+          # See https://docs.oracle.com/database/122/NEWFT/new-features.htm
+          # Identifier lengths were 30 *bytes* prior to Oracle 12C
+          def table_name_max
+            128
+          end
+
+          def column_name_max
+            128
+          end
+
+          def index_name_max
+            128
+          end
+
+          def schema_name_max
+            128   # Was 8 characters
+          end
+
+          def schema_prefix
+            ''
+          end
+
+          def index_kind(index)
+            super
+          end
+
+          def choose_sql_type(type_name, value_constraint, component, options)
+            type = MM::DataType.intrinsic_type(type_name)
+            case type
+            when MM::DataType::TYPE_Integer
+              # The :auto_assign key is set for auto-assigned types, but with a nil value in foreign keys
+              if options.has_key?(:auto_assign)
+                options[:default] = ' GENERATED BY DEFAULT ON NULL AS IDENTITY' if options[:auto_assign]
+                'LONGINTEGER'
+              else
+                super
+              end
+
+            when MM::DataType::TYPE_Money
+              'MONEY'
+
+            when MM::DataType::TYPE_DateTime
+              'DATETIME'
+
+            when MM::DataType::TYPE_Timestamp
+              'DATETIME'
+
+            when MM::DataType::TYPE_Binary
+              case binary_surrogate(type_name, value_constraint, options)
+              when :guid_fk             # A surrogate that's auto-assigned elsewhere
+                options[:length] = 16   # This will display as 32 hex digits
+                'RAW'
+              when :guid                # A GUID
+                options[:length] = 16
+                options[:default] = " DEFAULT SYS_GUID()"
+                'RAW'
+              when :hash                # A hash of the natural key
+                options[:length] = 20   # Assuming SHA-1. SHA-256 would need 32 bytes
+                leaves = component.root.natural_index.all_index_field.map(&:component)
+                options[:default] = " GENERATED ALWAYS AS #{hash(concatenate(coalesce(as_text(safe_column_exprs(leaves)))))}"
+                'RAW'
+              else
+                'LOB'                   # Not a surrogate, just use the type
+              end
+            else
+              super
+            end
+          end
+
+=begin
+          # Return an array of SQL statements that arrange for the hash_field
+          # to be populated with a hash of the values of the leaves.
+          def trigger_hash_assignment hash_field, leaves
+            table_name = safe_table_name(hash_field.root)
+            trigger_function = escape('assign_'+column_name(hash_field), 128)
+            [
+              %Q{
+                CREATE OR REPLACE
+                FUNCTION #{trigger_function}() RETURN RAW DETERMINISTIC
+                AS
+                   PRAGMA UDF;
+                BEGIN
+                   RETURN #{hash(concatenate(coalesce(as_text(safe_column_exprs(leaves, 'NEW')))))};
+                END #{trigger_function}}.
+              unindent,
+              %Q{     -- This is the Postgres syntax
+                CREATE TRIGGER trig_#{trigger_function}
+                        BEFORE INSERT OR UPDATE ON #{table_name}
+                        FOR EACH ROW EXECUTE PROCEDURE #{trigger_function}()}.
+              unindent
+            ]
+          end
+=end
+
+          # Some or all of the SQL expressions may have non-text values.
+          # Return an SQL expression that coerces them to text.
+          def as_text exprs
+            return exprs.map{|e| as_text(e)} if Array === exprs
+
+            Expression.new("#{exprs}", MM::DataType::TYPE_String, exprs.is_mandatory)
+          end
+
+          # Return an SQL expression that concatenates the given expressions (which must yield a string type)
+          def concatenate expressions
+            Expression.new(
+              "'|' || " +
+              expressions.map(&:to_s) * " || '|' || " +
+              " || '|'",
+              MM::DataType::TYPE_String,
+              true
+            )
+          end
+
+          # Return an expression that yields a hash of the given expression
+          def hash expr, algo = 'SHA-1'
+            # Since Oracle 12.1:
+            Expression.new("STANDARD_HASH(#{expr}, '#{algo}')", MM::DataType::TYPE_Binary, expr.is_mandatory)
+
+            # Expression.new("utl_raw.cast_to_raw(dbms_crypto.hash(#{expr}, dbms_crypto.hash_#{algo}))", MM::DataType::TYPE_Binary, expr.is_mandatory)
+          end
+
+          # Reserved words cannot be used anywhere without quoting.
+          # Keywords have existing definitions, so should not be used without quoting.
+          # Both lists here are added to the supertype's lists
+          def reserved_words
+            @oracle_reserved_words ||= %w{
+              ACCESS ARRAYLEN AUDIT CLUSTER COMMENT COMPRESS EXCLUSIVE
+              IDENTIFIED INDEX INITIAL LOCK LONG MAXEXTENTS MINUS
+              MODE MODIFY NOAUDIT NOCOMPRESS NOTFOUND NOWAIT OFFLINE
+              ONLINE PCTFREE RAW RENAME RESOURCE ROWID ROWLABEL ROWNUM
+              SHARE SQLBUF SUCCESSFUL SYNONYM SYSDATE UID VALIDATE
+              VARCHAR2
+            }
+            @oracle_plsql_reserved_words ||= %w{
+              ABORT ACCEPT ACCESS ARRAYLEN ASSERT ASSIGN BASE_TABLE
+              BINARY_INTEGER BODY CHAR_BASE CLUSTER CLUSTERS COLAUTH
+              COMPRESS CONSTANT CRASH CURRVAL DATABASE DATA_BASE DBA
+              DEBUGOFF DEBUGON DEFINITION DELAY DELTA DIGITS DISPOSE
+              ELSIF ENTRY EXCEPTION_INIT FORM GENERIC IDENTIFIED INDEX
+              INDEXES LIMITED MINUS MLSLABEL MODE NEXTVAL NOCOMPRESS
+              NUMBER_BASE PACKAGE PCTFREE POSITIVE PRAGMA PRIVATE
+              RAISE RECORD REMR RENAME RESOURCE REVERSE ROWID ROWLABEL
+              ROWNUM ROWTYPE RUN SEPARATE SQLERRM STDDEV SUBTYPE
+              TABAUTH TABLES TASK TERMINATE USE VARCHAR2 VARIANCE
+              VIEWS XOR
+            }
+            super + @oracle_reserved_words
+          end
+
+          def key_words
+            # These keywords should not be used for columns or tables:
+            @oracle_key_words ||= %w{
+              ANALYZE ARCHIVE ARCHIVELOG BACKUP BECOME BLOCK BODY
+              CACHE CANCEL CHANGE CHECKPOINT COMPILE CONTENTS CONTROLFILE
+              DATABASE DATAFILE DBA DISABLE DISMOUNT DUMP ENABLE
+              EVENTS EXCEPTIONS EXPLAIN EXTENT EXTERNALLY FLUSH FORCE
+              FREELIST FREELISTS INITRANS LAYER LISTS LOGFILE MANAGE
+              MANUAL MAXDATAFILES MAXINSTANCES MAXLOGFILES MAXLOGHISTORY
+              MAXLOGMEMBERS MAXTRANS MINEXTENTS MOUNT NOARCHIVELOG
+              NOCACHE NOCYCLE NOMAXVALUE NOMINVALUE NOORDER NORESETLOGS
+              NORMAL NOSORT OPTIMAL OWN PACKAGE PARALLEL PCTINCREASE
+              PCTUSED PLAN PRIVATE PROFILE QUOTA RECOVER RESETLOGS
+              RESTRICTED REUSE ROLES SCN SEGMENT SHARED SNAPSHOT SORT
+              STATEMENT_ID STATISTICS STOP STORAGE SWITCH TABLES
+              TABLESPACE THREAD TRACING TRIGGERS UNLIMITED USE
+            }
+            super + @oracle_key_words
+          end
+
+          def open_escape
+            '"'
+          end
+
+          def close_escape
+            '"'
+          end
+
+          def index_kind(index)
+            ''
+          end
+
+          class OracleDataTypeContext < SQLDataTypeContext
+            def integer_ranges
+              [
+                ['SHORTINTEGER', -2**15, 2**15-1],  # The standard says -10^5..10^5 (less than 16 bits)
+                ['INTEGER', -2**31, 2**31-1],   # The standard says -10^10..10^10 (more than 32 bits!)
+                ['LONGINTEGER', -2**63, 2**63-1],    # The standard says -10^19..10^19 (less than 64 bits)
+              ]
+            end
+
+            # PL/SQL has a BOOLEAN type, but Oracle databases do not, see
+            # https://docs.oracle.com/database/121/LNPLS/datatypes.htm#LNPLS348
+            def boolean_type
+              'CHAR(1)'   # Probably should put a CHECK '0' or '1' here
+            end
+
+            # Ugly, but safe (Oracle's internal schema tables use 'Y' and 'N'):
+            def boolean_expr safe_column_name
+              "(#{safe_column_name} = '1' OR #{safe_column_name} = 'Y')"
+            end
+
+            # There is no performance benefit in using fixed-length CHAR fields,
+            # and an added burden of trimming the implicitly added white-space
+            def default_char_type
+              (@unicode ? 'N' : '') +
+              'VARCHAR'
+            end
+
+            def default_varchar_type
+              (@unicode ? 'N' : '') +
+              'VARCHAR'
+            end
+
+            def date_time_type
+              'TIMESTAMP'
+            end
+          end
+        end
+
+      end
+    end
+  end
+end