Amazon Redshift Dialect of SqlAlchemy for OpenMetadata
Project description
sqlalchemy-redshift
Amazon Redshift dialect of SQLAlchemy for OpenMetadata.
.. image:: https://travis-ci.org/sqlalchemy-redshift/sqlalchemy-redshift.svg?branch=main :target: https://travis-ci.org/sqlalchemy-redshift/sqlalchemy-redshift :alt: Travis CI build status
Installation
The package is available on PyPI::
pip install sqlalchemy-redshift
.. warning::
This dialect requires psycopg2 library to work properly. It does not provide
it as required, but relies on you to select the psycopg2 distribution you need:
* psycopg2 - standard distribution of psycopg2, requires compilation so few system dependencies are required for it
* psycopg2-binary - already compiled distribution (no system dependencies are required)
* psycopg2cffi - pypy compatible version
See `Psycopg2's binary install docs <http://initd.org/psycopg/docs/install.html#binary-install-from-pypi>`_
for more context on choosing a distribution.
Usage
The DSN format is similar to that of regular Postgres::
>>> import sqlalchemy as sa
>>> sa.create_engine('redshift+psycopg2://username@host.amazonaws.com:5439/database')
Engine(redshift+psycopg2://username@host.amazonaws.com:5439/database)
See the RedshiftDDLCompiler documentation <https://sqlalchemy-redshift.readthedocs.org/en/latest/ddl-compiler.html>
_
for details on Redshift-specific features the dialect supports.
Releasing
To perform a release, you will need to be an admin for the project on GitHub and on PyPI. Contact the maintainers if you need that access.
You will need to have a ~/.pypirc
with your PyPI credentials and
also the following settings::
[zest.releaser]
create-wheels = yes
To perform a release, run the following::
python3.6 -m venv ~/.virtualenvs/dist
workon dist
pip install -U pip setuptools wheel
pip install -U tox zest.releaser
fullrelease # follow prompts, use semver ish with versions.
The releaser will handle updating version data on the package and in CHANGES.rst along with tagging the repo and uploading to PyPI.
0.8.7 (unreleased)
- Nothing changed yet.
0.8.6 (2021-09-22)
- Add RedshiftDialect_redshift_connector
(
Pull #232 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/232>
_) - Create RedshiftDialectMixin class. Add RedshiftDialect_psycopg2cffi.
(
Pull #231 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/231>
_)
0.8.5 (2021-08-23)
- Support TIMETZ datatype
(
Pull #229 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/229>
_) - Fix RelationKey unquoted issue
(
Pull #228 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/228>
_)
0.8.4 (2021-07-15)
- Improve reflection performance by fetching/caching metadata per schema
rather than for the entire database
(
Pull #223 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/223>
_)
0.8.3 (2021-07-07)
- SQLAlchemy 1.4.x support
(
Pull #221 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/221>
_)
0.8.2 (2021-01-08)
- Allow supplying multiple role ARNs in COPY and UNLOAD commands. This allows
the first role to assume other roles as explained
here <https://docs.aws.amazon.com/redshift/latest/mgmt/authorizing-redshift-service.html#authorizing-redshift-service-chaining-roles>
_.
0.8.1 (2020-07-15)
- Support AWS partitions for role-based access control in COPY and UNLOAD commands. This allows these commands to be used, e.g. in GovCloud.
0.8.0 (2020-06-30)
- Add option to drop materialized view with CASCADE
(
Pull #204 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/204>
_) - Fix invalid SQLAlchemy version comparison
(
Pull #206 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/206>
_)
0.7.9 (2020-05-29)
- Fix for supporting SQLAlchemy 1.3.11+
(
Issue #195 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/195>
_)
0.7.8 (2020-05-27)
- Added support for materialized views
(
Issue #202 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/202>
_) - Fix reflection of unique constraints
(
Issue #199 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/199>
_) - Support for altering column comments in Alembic migrations
(
Issue #191 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/191>
_)
0.7.7 (2020-02-02)
- Import Iterable from collections.abc for Python 3.9 compatibility
(
Issue #189 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/189>
_) - Add support for Parquet format in
UNLOAD
command (Issue #187 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/187>
_)
0.7.6 (2020-01-17)
- Fix unhashable type error for sortkey reflection in SQLAlchemy >= 1.3.11
(
Issue #180 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/180>
_) - Expose supported types for import from the dialect
(
Issue #181 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/181>
_) - Reflect column comments
(
Issue #186 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/186>
_)
0.7.5 (2019-10-09)
- Extend psycopg2 package version check to also support psycopg2-binary and psycopg2cffi
(
Issue #178 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/178>
_)
0.7.4 (2019-10-08)
- Drop hard dependency on psycopg2 but require package to be present on runtime
(
Issue #165 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/165>
_) - Switch from info to keyword arguments on columns for
SQLAlchemy >= 1.3.0
(Issue #161 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/161>
_) - Add support for column info on redshift late binding views
(
Issue #159 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/159>
_) - Add support for
MAXFILESIZE
argument toUNLOAD
. (Issue #123 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/123>
_) - Add support for the
CREATE LIBRARY
_ command. (Issue #124 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/124>
_) - Add support for the
ALTER TABLE APPEND
_ command. (Issue #162 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/162>
_) - Add support for the
CSV
format toUnloadFromSelect
. (Issue #169 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/169>
_) - Update the list of reserved words (adds "az64" and "language")
(
Issue #176 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/176>
_)
.. _CREATE LIBRARY: https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_LIBRARY.html .. _ALTER TABLE APPEND: https://docs.aws.amazon.com/redshift/latest/dg/r_ALTER_TABLE_APPEND.html
0.7.3 (2019-01-16)
- Add support for
REGION
argument toCOPY
andUNLOAD
commands. (Issue #90 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/90>
_)
0.7.2 (2018-12-11)
- Update tests to adapt to changes in Redshift and SQLAlchemy
(
Issue #140 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/140>
_) - Add
header
option toUnloadFromSelect
command (Issue #156 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/156>
_) - Add support for Parquet and ORC file formats in the COPY command
(
Issue #151 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/150>
_) - Add official support for Python 3.7
(
Issue #153 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/153>
_) - Avoid manipulating search path in table metadata fetch by using system tables
directly (
Issue #147 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/147>
_)
0.7.1 (2018-01-17)
- Fix incompatibility of reflection code with SQLAlchemy 1.2.0+
(
Issue #138 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/138>
_)
0.7.0 (2017-10-03)
- Do not enumerate
search_path
with external schemas (Issue #120 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/120>
_) - Return constraint name from get_pk_constraint and get_foreign_keys
- Use Enums for Format, Compression and Encoding.
Deprecate string parameters for these parameter types
(
Issue #133 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/133>
_) - Update included certificate with the
transitional ACM cert bundle <https://docs.aws.amazon.com/redshift/latest/mgmt/connecting-transitioning-to-acm-certs.html>
_ (Issue #130 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/130>
_)
0.6.0 (2017-05-04)
- Support role-based access control in COPY and UNLOAD commands
(
Issue #88 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/88>
_) - Increase max_identifier_length to 127 characters
(
Issue #96 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/96>
_) - Fix a bug where table names containing a period caused an error on reflection
(
Issue #97 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/97>
_) - Performance improvement for reflection by caching table constraint info
(
Issue #101 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/101>
_) - Support BZIP2 compression in COPY command
(
Issue #110 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/110>
_) - Allow tests to tolerate new default column encodings in Redshift
(
Issue #114 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/114>
_) - Pull in set of reserved words from Redshift docs
(
Issue #94 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/94>
_)
0.5.0 (2016-04-21)
- Support reflecting tables with foriegn keys to tables in non-public schemas
(
Issue #70 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/70>
_) - Fix a bug where DISTKEY and SORTKEY could not be used on column names containing
spaces or commas. This is a breaking behavioral change for a command like
__table_args__ = {'redshift_sortkey': ('foo, bar')}
. Previously, this would sort on the columns namedfoo
andbar
. Now, it sorts on the column namedfoo, bar
. (Issue #74 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/74>
_)
0.4.0 (2015-11-17)
- Change the name of the package to
sqlalchemy_redshift
to match the naming convention for other dialects; theredshift_sqlalchemy
package now emits aDeprecationWarning
and referencessqlalchemy_redshift
. Theredshift_sqlalchemy
compatibility package will be removed in a future release. (Issue #58 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/58>
_) - Fix a bug where reflected tables could have incorrect column order for some
CREATE TABLE
statements, particularly for columns with anIDENTITY
constraint. (Issue #60 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/60>
_) - Fix a bug where reflecting a table could raise a
NoSuchTableError
in cases where its schema is not on the currentsearch_path
(Issue #64 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/64>
_) - Add python 3.5 to the list of versions for integration tests.
(
Issue #61 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/61>
_)
0.3.1 (2015-10-08)
-
Fix breakages to CopyCommand introduced in 0.3.0: Thanks
solackerman <https://github.com/solackerman>
. (Issue #53 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/53>
)- When
format
is omitted, noFORMAT AS ...
is appended to the query. This makes the default the same as a normal redshift query. - fix STATUPDATE as a COPY parameter
- When
0.3.0 (2015-09-29)
-
Fix view support to be more in line with SQLAlchemy standards.
get_view_definition
output no longer includes a trailing semicolon and views no longer raise an exception when reflected asTable
objects. (Issue #46 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/46>
_) -
Rename RedShiftDDLCompiler to RedshiftDDLCompiler. (
Issue #43 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/43>
_) -
Update commands (
Issue #52 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/52>
_)- Expose optional TRUNCATECOLUMNS in CopyCommand.
- Add all other COPY parameters to CopyCommand.
- Move commands to their own module.
- Support inserts into ordered columns in CopyCommand.
0.2.0 (2015-09-04)
- Use SYSDATE instead of NOW().
Thanks
bouk <https://github.com/bouk>
. (Issue #15 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/15>
) - Default to SSL with hardcoded AWS Redshift CA.
(
Issue #20 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/20>
_) - Refactor of CopyCommand including support for specifying format and
compression type. (
Issue #21 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/21>
_) - Explicitly require SQLAlchemy >= 0.9.2 for 'dialect_options'.
(
Issue #13 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/13>
_) - Refactor of UnloadFromSelect including support for specifying all documented
redshift options.
(
Issue #27 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/27>
_) - Fix unicode issue with SORTKEY on python 2.
(
Issue #34 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/34>
_) - Add support for Redshift
DELETE
statements that refer other tables in theWHERE
clause. Thankshaleemur <https://github.com/haleemur>
. (Issue #35 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/35>
) - Raise
NoSuchTableError
when trying to reflect a table that doesn't exist. (Issue #38 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/issues/38>
_)
0.1.2 (2015-08-11)
- Register postgresql.visit_rename_table for redshift's
alembic RenameTable.
Thanks
bouk <https://github.com/bouk>
. (Issue #7 <https://github.com/sqlalchemy-redshift/sqlalchemy-redshift/pull/7>
)
0.1.1 (2015-05-20)
- Register RedshiftImpl as an alembic 3rd party dialect.
0.1.0 (2015-05-11)
- First version of sqlalchemy-redshift that can be installed from PyPI
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for openmetadata-sqlalchemy-redshift-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc2a9900c3b604eb34029f6a8b744d857187f36f3c32e1cffd78b279d80745cc |
|
MD5 | c7d6c97532bec40b794df27d52636022 |
|
BLAKE2b-256 | f9dc6edc3ee3eec3f53630bd51339086bba1ac070a6eaeab209012f00320cf8b |
Hashes for openmetadata_sqlalchemy_redshift-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99f7e799415abbddffed311a46d6c68c537be9e0b57eacc4f6ec70b72b6b402e |
|
MD5 | 3a3cf481e956e3bed1a1ff42e4bb7999 |
|
BLAKE2b-256 | a09ad61419ec185bc5239ab842486062404c059ba117bfb6648aeccd3af38063 |