调用格式如下:
sqlautocode <database_url> [options, ]
其中 database_url 就是我们使用 SQLAlchemy 时配置的数据库 url,有的人也习惯称之为 dsn。可选的参数如下:
-h, --help
显示帮助信息
-o OUTPUT, --output=OUTPUT
要写入的文件,默认是 stdout
--force
覆盖要写入的文件
-s SCHEMA, --schema=SCHEMA
可选参数,用于反向映射指定的数据库
-t TABLES, --tables=TABLES
可选参数,是一个使用逗号隔开的列表,用于指定要反向工程的表名,支持 * 作为通配符,例如:
--tables account_*,orders,order_items,*_audit
-b TABLE_PREFIX, --table-prefix=TABLE_PREFIX
生成的 SQLAclhemy 表对象的前缀
-a TABLE_SUFFIX, --table-suffix=TABLE_SUFFIX
生成的 SQLAclhemy 表对象的后缀
-i, --noindexes, --noindex
不生成索引信息
-g, --generic-types
生成是使用符合 ANSI 标准的字段类型而不是数据库特定的类型
--encoding=ENCODING
输出文件使用的编码,默认为 utf8
-e, --example
同时生成如何访问数据的示例代码
-3, --z3c
生成用于 z3c.sqlalchemy 的代码
-d, --declarative
生成使用 SQLAlchemy declarative 的代码
-n, --interactive
在生成的代码包含交互示例
example: sqlautocode mysql://user:password@host:port/datebase -o model_name.py -t table_name -e --force