1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/* Part of SWI-Prolog
Author: Mike Elston
Matt Lilley
E-mail: matt.s.lilley@gmail.com
WWW: http://www.swi-prolog.org
Copyright (c) 2014, Mike Elston, Matt Lilley
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
/* PostgreSQL is a trademark of the PostgreSQL Global Development Group.
Microsoft, SQL Server, and Windows are either registered trademarks or
trademarks of Microsoft Corporation in the United States and/or other
countries. SQLite is a registered trademark of Hipp, Wyrick & Company,
Inc in the United States. All other trademarks or registered trademarks
are the property of their respective owners.
*/
:-module(cql_autoschema,
[]).
% Database metadata API ---------------------------------------------------------------------------------------------------------------
/*
%% dbms(+Schema, -DBMSName).
% Determine the DBMS for a given Schema.
% Can be autoconfigured.
:-discontiguous(dbms/2).
%% odbc_data_type(+Schema, +TableSpec, +ColumnName, ?OdbcDataType)
% OdbcDataType must be a native SQL datatype, such as varchar(30) or decimal(10, 5)
% Can be autoconfigured.
:-discontiguous(odbc_data_type/4).
%% primary_key_column_name(+Schema, +TableName, -PrimaryKeyAttributeName).
% Can be autoconfigured.
:-discontiguous(primary_key_column_name/3).
%% database_attribute(?EntityType:table/view, ?Schema:atom, ?EntityName:atom, ?ColumnName:atom, ?DomainOrNativeType:atom, ?AllowsNulls:allows_nulls(true/false), ?IsIdentity:is_identity(true/false), ?ColumnDefault) is nondet.
% Can be autoconfigured.
:-discontiguous(database_attribute/8).
%% database_attribute(?DomainName:atom, ?OdbcDataType) is nondet.
% Can be autoconfigured.
:-discontiguous(database_domain/2).
%% routine_return_type(?Schema:atom, ?EntityName:atom, ?OdbcType).
% Can be autoconfigured
:-discontiguous(routine_return_type/3).
%% database_constraint(?Schema:atom, ?EntityName:atom, ?ConstraintName:atom, ?Constraint) is nondet.
% Constraint is one of:
% * primary_key(ColumnNames:list)
% * foreign_key(ForeignTableName:atom, ForeignColumnNames:list, ColumnNames:list)
% * unique(ColumnNames:list)
% * check(CheckClause)
% In theory this can be autoconfigured too, but I have not written the code for it yet
:-discontiguous(database_constraint/4).
*/
:-use_module(library(cql/cql_database)).
:-use_module(library(dcg/basics)).
% Automatic schema generation ---------------------------------------------------------------------------------------------------------------
% Works with PostgreSQL and SQLite. Could be extended to work with another DBMS easily enough
schema_fact(Schema, DBMS, dbms(Schema, DBMS)).
schema_fact(Schema, 'PostgreSQL', Fact):-
odbc_connection_call(Schema, Connection, odbc_query(Connection, 'SELECT table_name, column_name, data_type, character_maximum_length, numeric_precision, numeric_scale, domain_name, is_nullable, column_default FROM INFORMATION_SCHEMA.columns WHERE table_schema = \'public\'', row(EntityName, ColumnName, NativeType, CharacterMaximumLength, NumericPrecision, NumericScale, DomainType, IsNullable, ColumnDefault))),
( IsNullable == '1' -> AllowsNulls = allows_nulls(true) ; AllowsNulls = allows_nulls(false) ),
map_native_type(NativeType, CharacterMaximumLength, NumericPrecision, NumericScale, Mapped),
( DomainType \== {null} -> DomainOrNativeType = domain(DomainType) ; DomainOrNativeType = native_type(Mapped) ),
IsIdentity = is_identity(false),
( Fact = database_attribute(table, Schema, EntityName, ColumnName, DomainOrNativeType, AllowsNulls, IsIdentity, ColumnDefault)
; Fact = odbc_data_type(Schema, EntityName, ColumnName, Mapped)
).
schema_fact(Schema, 'PostgreSQL', primary_key_column_name(Schema, EntityName, ColumnName)):-
odbc_connection_call(Schema, Connection, odbc_query(Connection, 'SELECT kcu.table_name, column_name FROM INFORMATION_SCHEMA.key_column_usage KCU INNER JOIN INFORMATION_SCHEMA.table_constraints tc ON(tc.table_name = kcu.table_name AND tc.constraint_type = \'PRIMARY KEY\') WHERE kcu.table_schema = \'public\'', row(EntityName, ColumnName))).
schema_fact(Schema, 'PostgreSQL', database_domain(DomainName, Mapped)):-
odbc_connection_call(Schema, Connection, odbc_query(Connection, 'SELECT domain_name, data_type, character_maximum_length, numeric_precision, numeric_scale FROM INFORMATION_SCHEMA.domains WHERE domain_schema = \'public\'', row(DomainName, NativeType, CharacterMaximumLength, NumericPrecision, NumericScale))),
map_native_type(NativeType, CharacterMaximumLength, NumericPrecision, NumericScale, Mapped).
schema_fact(Schema, 'PostgreSQL', routine_return_type(Schema, RoutineName, Mapped)):-
odbc_connection_call(Schema, Connection, odbc_query(Connection, 'SELECT data_type, character_maximum_length, numeric_precision, numeric_scale FROM INFORMATION_SCHEMA.routines WHERE routine_schema = \'public\'', row(RoutineName, NativeType, CharacterMaximumLength, NumericPrecision, NumericScale))),
map_native_type(NativeType, CharacterMaximumLength, NumericPrecision, NumericScale, Mapped).
schema_fact(Schema, 'SQLite', Fact):-
findall(EntityName,
odbc_connection_call(Schema, Connection, odbc_query(Connection, 'SELECT name FROM sqlite_master WHERE type = \'table\'', row(EntityName))),
EntityNames),
member(EntityName, EntityNames),
format(atom(Pragma), 'PRAGMA table_info(~w)', [EntityName]),
odbc_connection_call(Schema, Connection, odbc_query(Connection, Pragma, Row)),
Row = row(_CID, ColumnName, ColumnTypeAtom, NotNullable, ColumnDefault, IsPkMember),
( NotNullable == 0 ->
AllowsNulls = allows_nulls(true)
; otherwise->
AllowsNulls = allows_nulls(false)
),
ColumnTypeAtom \== '', % sqlite_master contains sequence tables too, sadly. This excludes them
( sqlite_type(ColumnTypeAtom, ColumnType)->
true
; otherwise->
writeln(bad_type(EntityName, ColumnName, ColumnTypeAtom))
),
IsIdentity = is_identity(false), % FIXME
% SQLite does not support domains. Everything is a native_type
( ColumnType == datetime ->
% FIXME: What is going on here?
OdbcDataType = timestamp
; otherwise->
OdbcDataType = ColumnType
),
( Fact = database_attribute(table, Schema, EntityName, ColumnName, native_type(ColumnType), AllowsNulls, IsIdentity, ColumnDefault)
; Fact = odbc_data_type(Schema, EntityName, ColumnName, OdbcDataType)
; IsPkMember == 1, Fact = primary_key_column_name(Schema, EntityName, ColumnName)
).
map_native_type('character varying', N, _, _, varchar(N)):- !.
map_native_type('decimal', _, P, S, decimal(P, S)):- !.
map_native_type(X, _, _, _, X).
sqlite_type(Atom, Type):-
atom_codes(Atom, Codes),
sqlite_type_1(Type, Codes, []).
sqlite_type_1(decimal(P, S))-->
( "DECIMAL" ; "decimal" ; "Decimal"),
!,
whitespace, "(", whitespace, number(P), whitespace, ",", whitespace, number(S), whitespace, ")".
sqlite_type_1(varchar(N))-->
( "VARCHAR" ; "varchar" ; "Varchar"),
!,
whitespace, "(", whitespace, number(N), whitespace, ")".
sqlite_type_1(varbinary(max))-->
( "VARBINARY" ; "varbinary" ; "Varbinary"), !.
sqlite_type_1(longvarchar)-->
( "LONGVARCHAR" ; "longvarchar" ; "Longvarchar"), !.
sqlite_type_1(integer)-->
( "INTEGER" ; "integer" ; "Integer"), !.
sqlite_type_1(datetime)-->
( "DATETIME" ; "datetime" ; "Datetime"), !.
sqlite_type_1(bigint)-->
( "BIGINT" ; "bigint" ; "Bigint"), !.
sqlite_type_1(smallint)-->
( "SMALLINT" ; "smallint" ; "Smallint"), !.
whitespace--> [C], {code_type(C, white)}, !, whitespace.
whitespace--> [].
user:term_expansion(:-build_schema(Schema), Facts):-
odbc_connection_call(Schema, Connection, odbc_get_connection(Connection, dbms_name(DBMS))),
setof(cql:Fact,
schema_fact(Schema, DBMS, Fact),
Facts).
|
