Build with ply (lex & yacc in python). A lot of samples in 'tests/.
Yes, library already has about 7000+ downloads per day - https://pypistats.org/packages/simple-ddl-parser..
As maintainer, I guarantee that any backward incompatible changes will not be done in patch or minor version. But! Pay attention that sometimes output in keywords can be changed in minor version because of fixing wrong behaviour in past. For example, previously 'auto_increment' was a part of column type, but later it became a separate column property. So, please read for minor versions changedlog.
However, in process of adding support for new statements & features I see that output can be structured more optimal way and I hope to release version 1.0.*
with more struct output result. But, it will not be soon, first of all, I want to add support for so much statements as I can. So I don't think make sense to expect version 1.0.* before, for example, version 0.26.0
:)
Parser supports:
- SQL
- HQL (Hive)
- MSSQL dialec
- Oracle dialect
- MySQL dialect
- PostgreSQL dialect
- BigQuery
- Redshift
- Snowflake
- SparkSQL
- IBM DB2 dialect
You can check dialects sections after Supported Statements
section to get more information that statements from dialects already supported by parser. If you need to add more statements or new dialects - feel free to open the issue.
Pay attentions that I'm adding functional tests for all supported statement, so if you see that your statement is failed and you didn't see it in the test 99,9% that I did n't have sample with such SQL statement - so feel free to open the issue and I will add support for it.
If you need some statement, that not supported by parser yet: please provide DDL example & information about that is it SQL dialect or DB.
Types that are used in your DB does not matter, so parser must also work successfully to any DDL for SQL DB. Parser is NOT case sensitive, it did not expect that all queries will be in upper case or lower case. So you can write statements like this:
Alter Table Persons ADD CONSTRAINT CHK_PersonAge CHECK (Age>=18 AND City='Sandnes');
It will be parsed as is without errors.
If you have samples that cause an error - please open the issue (but don't forget to add ddl example), I will be glad to fix it.
A lot of statements and output result you can find in tests on the github - https://github.com/xnuinside/simple-ddl-parser/tree/main/tests .
pip install simple-ddl-parser
In some dialects like HQL there is a lot of additional information about table like, fore example, is it external table, STORED AS, location & etc. This property will be always empty in 'classic' SQL DB like PostgreSQL or MySQL and this is the reason, why by default this information are 'hidden'. Also some fields hidden in HQL, because they are simple not exists in HIVE, for example 'deferrable_initially' To get this 'hql' specific details about table in output please use 'output_mode' argument in run() method.
example:
ddl = """
CREATE TABLE IF NOT EXISTS default.salesorderdetail(
SalesOrderID int,
ProductID int,
OrderQty int,
LineTotal decimal
)
PARTITIONED BY (batch_id int, batch_id2 string, batch_32 some_type)
LOCATION 's3:https://datalake/table_name/v1'
ROW FORMAT DELIMITED
FIELDS TERMINATED BY ','
COLLECTION ITEMS TERMINATED BY '\002'
MAP KEYS TERMINATED BY '\003'
STORED AS TEXTFILE
"""
result = DDLParser(ddl).run(output_mode="hql")
print(result)
And you will get output with additional keys 'stored_as', 'location', 'external', etc.
# additional keys examples
{
...,
'location': "'s3:https://datalake/table_name/v1'",
'map_keys_terminated_by': "'\\003'",
'partitioned_by': [{'name': 'batch_id', 'size': None, 'type': 'int'},
{'name': 'batch_id2', 'size': None, 'type': 'string'},
{'name': 'batch_32', 'size': None, 'type': 'some_type'}],
'primary_key': [],
'row_format': 'DELIMITED',
'schema': 'default',
'stored_as': 'TEXTFILE',
...
}
If you run parser with command line add flag '-o=hql' or '--output-mode=hql' to get the same result.
Possible output_modes: ["mssql", "mysql", "oracle", "hql", "sql", "redshift", "snowflake"]
from simple_ddl_parser import DDLParser
parse_results = DDLParser("""create table dev.data_sync_history(
data_sync_id bigint not null,
sync_count bigint not null,
sync_mark timestamp not null,
sync_start timestamp not null,
sync_end timestamp not null,
message varchar(2000) null,
primary key (data_sync_id, sync_start)
); """).run()
print(parse_results)
from simple_ddl_parser import parse_from_file
result = parse_from_file('tests/sql/test_one_statement.sql')
print(result)
simple-ddl-parser is installed to environment as command sdp
sdp path_to_ddl_file
# for example:
sdp tests/sql/test_two_tables.sql
You will see the output in schemas folder in file with name test_two_tables_schema.json
If you want to have also output in console - use -v flag for verbose.
sdp tests/sql/test_two_tables.sql -v
If you don't want to dump schema in file and just print result to the console, use --no-dump flag:
sdp tests/sql/test_two_tables.sql --no-dump
You can provide target path where you want to dump result with argument -t, --target:
sdp tests/sql/test_two_tables.sql -t dump_results/
If you want to get output in JSON in stdout you can use argument json_dump=True in method .run() for this
from simple_ddl_parser import DDLParser
parse_results = DDLParser("""create table dev.data_sync_history(
data_sync_id bigint not null,
sync_count bigint not null,
); """).run(json_dump=True)
print(parse_results)
Output will be:
[{"columns": [{"name": "data_sync_id", "type": "bigint", "size": null, "references": null, "unique": false, "nullable": false, "default": null, "check": null}, {"name": "sync_count", "type": "bigint", "size": null, "references": null, "unique": false, "nullable": false, "default": null, "check": null}], "primary_key": [], "alter": {}, "checks": [], "index": [], "partitioned_by": [], "tablespace": null, "schema": "dev", "table_name": "data_sync_history"}]
DDLParser(ddl).run()
.run() method contains several arguments, that impact changing output result. As you can saw upper exists argument output_mode
that allow you to set dialect and get more fields in output relative to chosen dialect, for example 'hql'. Possible output_modes: ["mssql", "mysql", "oracle", "hql", "sql"]
Also in .run() method exists argument group_by_type
(by default: False). By default output of parser looks like a List with Dicts where each dict == one entity from ddl (table, sequence, type, etc). And to understand that is current entity you need to check Dict like: if 'table_name' in dict - this is a table, if 'type_name' - this is a type & etc.
To make work little bit easy you can set group_by_type=True and you will get output already sorted by types, like:
{
'tables': [all_pasrsed_tables],
'sequences': [all_pasrsed_sequences],
'types': [all_pasrsed_types],
'domains': [all_pasrsed_domains],
...
}
For example:
ddl = """
CREATE TYPE "schema--notification"."ContentType" AS
ENUM ('TEXT','MARKDOWN','HTML');
CREATE TABLE "schema--notification"."notification" (
content_type "schema--notification"."ContentType"
);
CREATE SEQUENCE dev.incremental_ids
INCREMENT 10
START 0
MINVALUE 0
MAXVALUE 9223372036854775807
CACHE 1;
"""
result = DDLParser(ddl).run(group_by_type=True)
# result will be:
{'sequences': [{'cache': 1,
'increment': 10,
'maxvalue': 9223372036854775807,
'minvalue': 0,
'schema': 'dev',
'sequence_name': 'incremental_ids',
'start': 0}],
'tables': [{'alter': {},
'checks': [],
'columns': [{'check': None,
'default': None,
'name': 'content_type',
'nullable': True,
'references': None,
'size': None,
'type': '"schema--notification"."ContentType"',
'unique': False}],
'index': [],
'partitioned_by': [],
'primary_key': [],
'schema': '"schema--notification"',
'table_name': '"notification"'}],
'types': [{'base_type': 'ENUM',
'properties': {'values': ["'TEXT'", "'MARKDOWN'", "'HTML'"]},
'schema': '"schema--notification"',
'type_name': '"ContentType"'}]}
Right now added support only for ALTER statements with FOREIGEIN key
For example, if in your ddl after table definitions (create table statements) you have ALTER table statements like this:
ALTER TABLE "material_attachments" ADD FOREIGN KEY ("material_id", "material_title") REFERENCES "materials" ("id", "title");
This statements will be parsed and information about them putted inside 'alter' key in table's dict. For example, please check alter statement tests - tests/test_alter_statements.py
You can find in tests/ folder.
To dump result in json use argument .run(dump=True)
You also can provide a path where you want to have a dumps with schema with argument .run(dump_path='folder_that_use_for_dumps/')
By default Parser does not raise the error if some statement cannot be parsed - and just skip & produce empty output.
To change this behavior you can pass 'silent=False' argumen to main parser class, like:
DDLParser(.., silent=False)
Use DDLParser(.., normalize_names=True)flag that change output of parser: If flag is True (default 'False') then all identifiers will be returned without '[', '"' and other delimiters that used in different SQL dialects to separate custom names from reserved words & statements. For example, if flag set 'True' and you pass this input:
CREATE TABLE [dbo].[TO_Requests]( [Request_ID] [int] IDENTITY(1,1) NOT NULL, [user_id] [int]
In output you will have names like 'dbo' and 'TO_Requests', not '[dbo]' and '[TO_Requests]'.
-
CREATE [OR REPLACE] TABLE [ IF NOT EXISTS ] + columns definition, columns attributes: column name + type + type size(for example, varchar(255)), UNIQUE, PRIMARY KEY, DEFAULT, CHECK, NULL/NOT NULL, REFERENCES, ON DELETE, ON UPDATE, NOT DEFERRABLE, DEFERRABLE INITIALLY, GENERATED ALWAYS, STORED, COLLATE
-
STATEMENTS: PRIMARY KEY, CHECK, FOREIGN KEY in table definitions (in create table();)
-
ALTER TABLE STATEMENTS: ADD CHECK (with CONSTRAINT), ADD FOREIGN KEY (with CONSTRAINT), ADD UNIQUE, ADD DEFAULT FOR, ALTER TABLE ONLY, ALTER TABLE IF EXISTS; ALTER .. PRIMARY KEY; ALTER .. USING INDEX TABLESPACE
-
PARTITION BY statement
-
CREATE SEQUENCE with words: INCREMENT [BY], START [WITH], MINVALUE, MAXVALUE, CACHE
-
CREATE TYPE statement: AS TABLE, AS ENUM, AS OBJECT, INTERNALLENGTH, INPUT, OUTPUT
-
LIKE statement (in this and only in this case to output will be added 'like' keyword with information about table from that we did like - 'like': {'schema': None, 'table_name': 'Old_Users'}).
-
TABLESPACE statement
-
COMMENT ON statement
-
CREATE SCHEMA [IF NOT EXISTS] ... [AUTHORIZATION] ...
-
CREATE DOMAIN [AS]
-
CREATE [SMALLFILE | BIGFILE] [TEMPORARY] TABLESPACE statement
-
CREATE DATABASE + Properties parsing
- USING
- PARTITIONED BY statement
- ROW FORMAT, ROW FORMAT SERDE
- WITH SERDEPROPERTIES ("input.regex" = "..some regex..")
- STORED AS (AVRO, PARQUET, etc), STORED AS INPUTFORMAT, OUTPUTFORMAT
- COMMENT
- LOCATION
- FIELDS TERMINATED BY, LINES TERMINATED BY, COLLECTION ITEMS TERMINATED BY, MAP KEYS TERMINATED BY
- TBLPROPERTIES ('parquet.compression'='SNAPPY' & etc.)
- SKEWED BY
- CLUSTERED BY
- ON UPDATE in column without reference
- CONSTRAINT [CLUSTERED]... PRIMARY KEY
- CONSTRAINT ... WITH statement
- PERIOD FOR SYSTEM_TIME in CREATE TABLE statement
- ON [PRIMARY] after CREATE TABLE statement (sample in test files test_mssql_specific.py)
- WITH statement for TABLE properties
- TEXTIMAGE_ON statement
- DEFAULT NEXT VALUE FOR in COLUMN DEFAULT
- type IDENTITY statement
- FOREIGN KEY REFERENCES statement
- 'max' specifier in column size
- CONSTRAINT ... UNIQUE, CONSTRAINT ... CHECK, CONSTRAINT ... FOREIGN KEY, CONSTRAINT ... PRIMARY KEY
- CREATE CLUSTERED INDEX
- CREATE TABLE (...) ORGANIZATION INDEX
- ENCRYPT column property [+ NO SALT, SALT, USING]
- STORAGE column property
- INHERITS table statement - https://postgrespro.ru/docs/postgresql/14/ddl-inherit
-
ENCODE column property
-
SORTKEY, DISTSTYLE, DISTKEY, ENCODE table properties
-
CREATE TEMP / TEMPORARY TABLE
-
syntax like with LIKE statement:
create temp table tempevent(like event);
- CREATE .. CLONE statements for table, database and schema
- CREATE TABLE [or REPLACE] [ TRANSIENT | TEMPORARY ] .. CLUSTER BY ..
- CONSTRAINT .. [NOT] ENFORCED
- COMMENT = in CREATE TABLE & CREATE SCHEMA statements
- WITH MASKING POLICY
- WITH TAG, including multiple tags in the same statement.
- DATA_RETENTION_TIME_IN_DAYS
- MAX_DATA_EXTENSION_TIME_IN_DAYS
- CHANGE_TRACKING
- OPTION in CREATE SCHEMA statement
- OPTION in CREATE TABLE statement
- OPTION in column definition statement
- Logging to file
To get logging output to file you should provide to Parser 'log_file' argument with path or file name:
DDLParser(ddl, log_file='parser221.log').run(group_by_type=True)
- Logging level
To set logging level you should provide argument 'log_level'
DDLParser(ddl, log_level=logging.INFO).run(group_by_type=True)
-1. Update command line to parse all arguments, that supported by Parser 0. Add support for ALTER TABLE ... ADD COLUMN
- Add more support for CREATE type IS TABLE (example: CREATE OR REPLACE TYPE budget_tbl_typ IS TABLE OF NUMBER(8,2);
- Add support (ignore correctly) ALTER TABLE ... DROP CONSTRAINT ..., ALTER TABLE ... DROP INDEX ...
- Change output for CHECKS -> 'checks': [{"column_name": str, "operator": =
=|<|>|<=..., "value": value}]
- Add support for ALTER TABLE ... ADD INDEX
- Provide API to get result as Python Object
- Add online demo (UI) to parse ddl
Big thanks for the involving & contribution with test cases with DDL samples & opening issues goes to:
- https://github.com/kukigai ,
- https://github.com/Awalkman90 ,
- https://github.com/geob3d
for help with debugging & testing support for BigQuery dialect DDLs:
And most biggest 'Thanks' ever goes for contributions in parser: https://github.com/swiatek25 https://github.com/slurpyb https://github.com/dmaresma https://github.com/PBalsdon
v0.31.2
- Added support for Snowflake AUTOINCREMENT | IDENTITY column definitions with optional parameter
ORDER|NOORDER
statement - #213
- Added param 'encoding' to parse_from_file function - #142. Default encoding is utf-8.
v0.31.1
- Support multiple tag definitions in a single
WITH TAG
statement. - Added support for Snowflake double single quotes - #208
v0.31.0
- Added
Snowflake Table DDL support of WITH MASKING POLICY column definition
- #201
- All deps updated to the latest versions.
v0.30.0
- IDENTITY now parsed normally as a separate column property. Issue: #184
-
IN TABLESPACE IBM DB2 statement now is parsed into 'tablespace' key. Issue: #194. INDEX IN also parsed to 'index_in' key. Added support for ORGANIZE BY statement
-
Added support for PostgreSQL INHERITS statement. Issue: #191
v0.29.1
- Python 3.6 is deprecated in tests and by default, try to move to Python3.7, but better to 3.8, because 3.7 will be deprecated in 2023.
- Fix for #177
- Added support for Oracle 2 component size for types, like '30 CHAR'. From #176
v0.29.0
- AUTOINCREMENT statement now parsed validly same way as AUTO_INCREMENT and showed up in output as 'autoincrement' property of the column Fix for: #170
- Fix issue ' TypeError argument of type 'NoneType' is not iterable' on some foreigen keys #148
- Support for non-numeric column type parameters #171 It shows in column attribute 'type_parameters'.
v0.28.1 Improvements:
- Lines started with INSERT INTO statement now successfully ignored by parser (so you can keep them in ddl - they will be just skipped)
Fixes:
- Important fix for multiline comments
v0.28.0
Important Changes (Pay attention):
- Because of parsing now AUTO_INCREMENT as a separate property of column previous output changed. Previously it was parsed as a part of type like: 'INT AUTO_INCREMENT'. Now type will be only 'INT', but in column property you will see 'autoincrement': True.
Amazing innovation:
- It's is weird to write in Changelog, but only in version 0.28.0 I recognize that floats that not supported by parser & it was fixed. Thanks for the sample in the issue: #163
Improvements: MariaDB:
- Added support for MariaDB AUTO_INCREMENT (from ddl here - #144) If column is Auto Incremented - it indicated as 'autoincrement': True in column definition
Common:
- Added parsing for multiline comments in DDL with
/* */
syntax. - Comments from DDL now all placed in 'comments' keyword if you use
group_by_type=
arg in parser. - Added argument 'parser_settings={}' (dict type) in method parse_from_file() - this way you can pass any arguments that you want to DDLParser (& that supported by it) So, if you want to set log_level=logging.WARNING for parser - just use it as: parse_from_file('path_to_file', parser_settings={'log_level': logging.WARNING}). For issue: #160
v0.27.0
Fixes:
Improvements:
- Added support for '*' in size column (ORACLE dialect) - #151
- Added arg 'debug' to parser, works same way as 'silent' - to get more clear error output.
New features:
- Added support for ORACLE 'ORGANIZATION INDEX'
- Added support for SparkSQL Partition by with procedure call - #154
- Added support for DEFAULT CHARSET statement MySQL - #153
v0.26.5
Fixes:
- Parsetab included in builds.
- Added additional argumen log_file='path_to_file', to enable logging to file with providen name.
v0.26.4
- Bugfix for (support CREATE OR REPLACE with additional keys like transient/temporary): #133
v0.26.3
Improvements:
v0.26.2
Fixes:
- Fixed a huge bug for incorrect parsing lines with 'USE' & 'GO' strings inside.
- Fixed parsing for CREATE SCHEMA for Snowlake & Oracle DDLs
Improvements:
- Added COMMENT statement for CREATE TABLE ddl (for SNOWFLAKE dialect support)
- Added COMMENT statement for CREATE SCHEMA ddl (for SNOWFLAKE dialect support)
v0.26.1
Fixes:
- support Multiple SERDEPROPERTIES - #126
- Fix for issue with LOCATION and TBLPROPERTIES clauses in CREATE TABLE LIKE - #125
- LOCATION now works correctly with double quote strings
v0.26.0 Improvements:
- Added more explicit debug message on Statement errors - #116
- Added support for "USING INDEX TABLESPACE" statement in ALTER - #119
- Added support for IN statements in CHECKS - #121
New features:
- Support SparkSQL USING - #117 Updates initiated by ticket #120:
- In Parser you can use argument json_dump=True in method .run() if you want get result in JSON format.
- README updated
Fixes:
- Added support for PARTITION BY one column without type
- Alter table add constraint PRIMARY KEY - #119
- Fix for paring SET statement - #122
- Fix for disappeared columns without properties - #123
v0.25.0
- Fix for issue with 'at time zone' #112
- Added flag to raise errors if parser cannot parse statement DDLParser(.., silent=False) - #109
- Added flag to DDLParser(.., normalize_names=True) that change output of parser: if flag is True (default 'False') then all identifiers will be returned without '[', '"' and other delimiters that used in different SQL dialects to separate custom names from reserved words & statements. For example, if flag set 'True' and you pass this input:
CREATE TABLE [dbo].[TO_Requests]( [Request_ID] [int] IDENTITY(1,1) NOT NULL, [user_id] [int]
In output you will have names like 'dbo' and 'TO_Requests', not '[dbo]' and '[TO_Requests]'.
v0.24.2
- Fix for the issue: #108 (reserved words can be used as table name after '.')
v0.24.1
- fields_terminated_by now parses , as "','", not as '' previously
- To output added 'if_not_exists' field in result to get availability 1-to-1 re-create ddl by metadata.
v0.24.0
- More then 2 tblproperties now are parsed correctly #104
- 'set' in lower case now also parsed validly.
- Now names like 'schema', 'database', 'table' can be used as names in CREATE DATABASE | SCHEMA | TABLESPACE | DOMAIN | TYPE statements and after INDEX and CONSTRAINT.
- Creation of empty tables also parsed correctly (like CREATE Table table;).
- Added support for CLUSTERED BY - #103
- Added support for INTO ... BUCKETS
- CREATE REMOTE DATABASE | SCHEMA
v0.23.0
Big refactoring: less code complexity & increase code coverage. Radon added to pre-commit hooks.
- Fix for issue with ALTER UNIQUE - #101
- SQL Comments string from DDL now parsed to "comments" key in output.
PostgreSQL:
- Added support for ALTER TABLE ONLY | ALTER TABLE IF EXISTS
v0.22.5
- Fix for issue with '<' - #89
v0.22.4
- Fixed issue with parsing schemas with project in name.
- Added support for multiple OPTION() statements
v0.22.3
- CREATE TABLE statement with 'project_id' in format like project.dataset.table_name now is parsed validly. 'project' added to output. Also added support project.dataset.name format in CREATE SCHEMA and ALTER statement
v0.22.2
- Fix for the issue: #94 (column name starts with CREATE)
v0.22.1
- Added support for OPTION for full CREATE TABLE statement & column definition
- CLUSTED BY can be used without ()
v0.22.0
I started to add partial support for BigQuery
- Added support for OPTIONS in CREATE SCHEMA statement
- Added support for PRIMARY KEY CLUSTERED - full details about clusterisation are parsed now in separate key 'clustered_primary_key'. I don't like that but when I started I did not thought about all those details, so in version 1.0.* I will work on more beautiful and logically output structure. #91
Pay attention: previously they parsed somehow, but in incorrect structure.
- Strings in double quotes moved as separate token from ID to fix a lot of issues with strings with spaces inside
- Now parser can parse statements separated by new line also (without GO or ; at the end of statement) - #90
- Now open strings is not valid in checks (previously the was parsed.) Open string sample 'some string (exist open quote, but there is no close quote)
- Order like ASC, DESK in primary keys now parsed valid (not as previously as column name)
v0.21.2 Fixies:
- remove 'PERIOD' from tokens
v0.21.1 Fixies:
- START WITH, INCREMENT BY and CACHE (without value) in sequences now is parsed correctly.
v0.21.0
## MSSQL:
1. Added support for statements:
1. PERIOD FOR SYSTEM_TIME in CREATE TABLE statement
2. ON [PRIMARY] after CREATE TABLE statement (sample in test files test_mssql_specific.py)
3. WITH statement for TABLE properties
4. TEXTIMAGE_ON statement
5. DEFAULT NEXT VALUE FOR in COLUMN DEFAULT
2. Added support for separating tables DDL by 'GO' statement as in output of MSSQL
3. Added support for CREATE TYPE as TABLE
v0.20.0
#### Common
1. SET statements from DDL scripts now collected as type 'ddl_properties' (if you use group_by_type=True) and parsed as
dicts with 2 keys inside {'name': 'property name', 'value': 'property value'}
#### MySQL
2. Added support for MySQL ON UPDATE statements in column (without REFERENCE)
#### MSSQL
3. Added support for CONSTRAINT [CLUSTERED]... PRIMARY KEY for Table definition
4. Added support for WITH statement in CONSTRAINT (Table definition)