summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/orm/shard.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/sqlalchemy/orm/shard.py')
-rw-r--r--lib/sqlalchemy/orm/shard.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/sqlalchemy/orm/shard.py b/lib/sqlalchemy/orm/shard.py
index 5036bc115..7cf4eb2cc 100644
--- a/lib/sqlalchemy/orm/shard.py
+++ b/lib/sqlalchemy/orm/shard.py
@@ -1,3 +1,10 @@
+"""Defines a rudimental 'horizontal sharding' system which allows a
+Session to distribute queries and persistence operations across multiple
+databases.
+
+For a usage example, see the example ``examples/sharding/attribute_shard.py``.
+
+"""
from sqlalchemy.orm.session import Session
from sqlalchemy.orm.query import Query
from sqlalchemy import exceptions, util