Skip to content

Commit 6425cc4

Browse files
committed
Documentation: Educate about CrateDB and eventual consistency vs. ACID
1 parent cf37370 commit 6425cc4

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/connect.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,16 @@ Here's what we changed in the above example:
8686
:ref:`data types <data-types>` appendix for more information about type
8787
maps and column type definitions.
8888

89+
Eventual consistency
90+
====================
91+
92+
Note that CrateDB is primarily an analytical database for big data, so it
93+
implements `eventual consistency`_ and does not support traditional ACID
94+
transactions.
95+
96+
Please use `REFRESH TABLE`_ for establishing read-after-write consistency
97+
when applicable.
98+
8999
Next steps
90100
==========
91101

@@ -98,4 +108,6 @@ your setup process.
98108
.. _Doctrine provided example: https://www.doctrine-project.org/projects/doctrine-orm/en/3.0/reference/configuration.html#obtaining-an-entitymanager
99109
.. _Object-Relational Mapping: https://www.doctrine-project.org/projects/orm.html
100110
.. _Doctrine ORM documentation: https://www.doctrine-project.org/projects/doctrine-orm/en/3.0/index.html
111+
.. _eventual consistency: https://community.cratedb.com/t/fundamentals-of-eventual-consistency-in-cratedb/1235
112+
.. _REFRESH TABLE: https://cratedb.com/docs/crate/reference/en/5.10/general/dql/refresh.html
101113
.. _standard DBAL parameters: https://www.doctrine-project.org/projects/doctrine-dbal/en/3.0/reference/configuration.html

0 commit comments

Comments
 (0)