https://github.com/mahmoudimus/sqlalchemy-citext

CITEXT type for SQLAlchemy
https://github.com/mahmoudimus/sqlalchemy-citext

citext python sqlalchemy sqlalchemy-orm

Last synced: 3 months ago
JSON representation

CITEXT type for SQLAlchemy

• Host: GitHub
• URL: https://github.com/mahmoudimus/sqlalchemy-citext
• Owner: mahmoudimus
• License: other
• Created: 2012-03-30T01:16:46.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2023-05-24T19:13:44.000Z (over 2 years ago)
• Last Synced: 2024-10-29T23:19:25.047Z (over 1 year ago)
• Topics: citext, python, sqlalchemy, sqlalchemy-orm
• Language: Python
• Homepage:
• Size: 24.4 KB
• Stars: 29
• Watchers: 2
• Forks: 14
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
sqlalchemy-citext

=================

Creates a SQLAlchemy user defined type to understand

`PostgreSQL's CIText `_

extension.

Installation

------------

This requires some kind of PostgreSQL compatible db-api driver already

installed in order to work.

Make sure you have something like ``psycopg2`` already installed.

.. code-block:: console

    pip install sqlalchemy-citext

Usage

-----

.. code-block:: python

    from sqlalchemy import create_engine, MetaData, Integer

    from sqlalchemy.schema import Column, Table

    import sqlalchemy.orm as orm

    from citext import CIText

    engine = create_engine('postgresql://localhost/test_db')

    meta = MetaData()

    test_table = Table('test', meta,

        Column('id', Integer(), primary_key=True),

        Column('txt', CIText()))

    conn = engine.connect()

    meta.bind = conn

    meta.drop_all()

    meta.create_all()

    class TestObj(object):

        def __init__(self, id_, txt):

            self.id = id_

            self.txt = txt

        def __repr__(self):

            return "TestObj(%r, %r)" % (self.id, self.txt)

    orm.mapper(TestObj, test_table)

    Session = orm.sessionmaker(bind=engine)

    ses = Session()

    to = TestObj(1, txt='FooFighter')

    ses.add(to)

    ses.commit()

    row = ses.query(TestObj).filter(TestObj.txt == 'foofighter').all()

    assert len(row) == 1

    print row

    ses.close()

License

-------

``sqlalchemy-citext`` is an MIT/BSD dual-Licensed library.

Contribute

----------

- Check for open issues or open a fresh issue to start a discussion around a

  feature idea or a bug.

- Fork the repository on GitHub to start making your changes to the master

  branch (or branch off of it).

- Write a test which shows that the bug was fixed or that the feature

  works as expected.

- Send a pull request and bug the maintainer until it gets merged and

  published.

- Make sure to add yourself to the author's file in ``setup.py`` and the

  ``Contributors`` section below :)

Contributors

------------

- `@mahmoudimus `_

- `@vad `_

- `@dstufft `_

- `@brmzkw `_

- `@graingert `_

- `@cjmayo `_

- `@libre-man `_