Add note regarding encryption-related pragmas

passed in the url in pysqlcipher.

Fixes: #6589
Change-Id: I86f93f84ef2bd374c4832a70e26e4901d024ed4b

diff --git a/doc/build/changelog/unreleased_13/6589.rst b/doc/build/changelog/unreleased_13/6589.rst
new file mode 100644 (file)
index 0000000..7d7530e
--- /dev/null
+++ b/doc/build/changelog/unreleased_13/6589.rst
@@ -0,0 +1,6 @@
+.. change::
+    :tags: bug, pysqlcipher
+    :tickets: 6589
+    :versions: 1.4.18
+
+    Add note regarding encryption-related pragmas passed in the url.

diff --git a/lib/sqlalchemy/dialects/sqlite/pysqlcipher.py b/lib/sqlalchemy/dialects/sqlite/pysqlcipher.py
index 1a9337671ed318785ac14d4030af80cecfc1bc2a..aafc00844f0968936219850b6513a5ea9e9d7859 100644 (file)
--- a/lib/sqlalchemy/dialects/sqlite/pysqlcipher.py
+++ b/lib/sqlalchemy/dialects/sqlite/pysqlcipher.py
@@ -68,6 +68,11 @@ new connection.  Currently, ``cipher``, ``kdf_iter``
 
     e = create_engine('sqlite+pysqlcipher://:testing@/foo.db?cipher=aes-256-cfb&kdf_iter=64000')
 
+.. warning:: Previous versions of sqlalchemy did not take into consideration
+   the encryption-related pragmas passed in the url string, that were silently
+   ignored. This may cause errors when opening files saved by a
+   previous sqlalchemy version if the encryption options do not match.
+
 
 Pooling Behavior
 ----------------