Added docs for ScalarList
This commit is contained in:
@@ -8,13 +8,55 @@ SQLAlchemy-Utils
|
|||||||
|
|
||||||
SQLAlchemy-Utils provides various utility classes and functions for SQLAlchemy.
|
SQLAlchemy-Utils provides various utility classes and functions for SQLAlchemy.
|
||||||
|
|
||||||
|
ScalarList
|
||||||
|
----------
|
||||||
|
|
||||||
|
ScalarList type provides convenient way for saving multiple scalar values in one
|
||||||
|
column. ScalarList works like list on python side and saves the result as comma-separated list
|
||||||
|
in the database (custom separators can also be used).
|
||||||
|
|
||||||
|
Example ::
|
||||||
|
|
||||||
|
|
||||||
|
from sqlalchemy_utils import ScalarList
|
||||||
|
|
||||||
|
|
||||||
|
class User(Base):
|
||||||
|
__tablename__ = 'user'
|
||||||
|
id = db.Column(db.Integer, autoincrement=True)
|
||||||
|
hobbies = db.Column(ScalarList())
|
||||||
|
|
||||||
|
|
||||||
|
user = User()
|
||||||
|
user.hobbies = [u'football', u'ice_hockey']
|
||||||
|
session.commit()
|
||||||
|
|
||||||
|
|
||||||
|
You can easily set up integer lists too:
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
|
||||||
|
from sqlalchemy_utils import ScalarList
|
||||||
|
|
||||||
|
|
||||||
|
class Player(Base):
|
||||||
|
__tablename__ = 'player'
|
||||||
|
id = db.Column(db.Integer, autoincrement=True)
|
||||||
|
points = db.Column(ScalarList(int))
|
||||||
|
|
||||||
|
|
||||||
|
player = Player()
|
||||||
|
player.points = [11, 12, 8, 80]
|
||||||
|
session.commit()
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
API Documentation
|
API Documentation
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
.. module:: sqlalchemy_utils
|
.. module:: sqlalchemy_utils
|
||||||
.. autoclass:: SmartList
|
.. autoclass:: InstrumentedList
|
||||||
:members:
|
:members:
|
||||||
.. autofunction:: sort_query
|
.. autofunction:: sort_query
|
||||||
.. autofunction:: escape_like
|
.. autofunction:: escape_like
|
||||||
|
Reference in New Issue
Block a user