Metadata-Version: 2.0
Name: sqliteschema
Version: 0.9.2
Summary:     A python library to dump table schema of a SQLite database file.
    
Home-page: https://github.com/thombashi/sqliteschema
Author: Tsuyoshi Hombashi
Author-email: tsuyoshi.hombashi@gmail.com
License: MIT License
Keywords: SQLite,library,schema
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Database
Requires-Dist: logbook
Requires-Dist: pytablewriter (>=0.21.0)
Requires-Dist: SimpleSQLite (>=0.11.0)
Requires-Dist: six
Requires-Dist: typepy (>=0.0.12)

sqliteschema
===============

.. image:: https://badge.fury.io/py/sqliteschema.svg
    :target: https://badge.fury.io/py/sqliteschema

.. image:: https://img.shields.io/pypi/pyversions/sqliteschema.svg
    :target: https://pypi.python.org/pypi/sqliteschema

.. image:: https://img.shields.io/travis/thombashi/sqliteschema/master.svg?label=Linux
    :target: https://travis-ci.org/thombashi/sqliteschema

.. image:: https://img.shields.io/appveyor/ci/thombashi/sqliteschema/master.svg?label=Windows
    :target: https://ci.appveyor.com/project/thombashi/sqliteschema/branch/master

.. image:: https://coveralls.io/repos/github/thombashi/sqliteschema/badge.svg?branch=master
    :target: https://coveralls.io/github/thombashi/sqliteschema?branch=master


Summary
=======
Python library to dump table schema of a SQLite database file.


Installation
============

::

    pip install sqliteschema


Usage
=====
Full example can be found at examples/get_table_schema.py

Extract SQLite Schema
----------------------------------

.. code:: python

    for verbosity_level in range(2):
        print("----- get_table_schema method: verbosity_level={} -----".format(
            verbosity_level))
        extractor = sqliteschema.SqliteSchemaExtractor(
            sqlite_db_path, verbosity_level=verbosity_level,
            output_format="table")
        for table_name in extractor.get_table_name_list():
            print("{:s} {}".format(
                table_name,
                extractor.get_table_schema(table_name)))
        print()

.. code::

    ----- get_table_schema method: verbosity_level=0 -----
    sampletable0 ['attr_a', 'attr_b']
    sampletable1 ['foo', 'bar', 'hoge']
    constraints ['primarykey_id', 'notnull_value', 'unique_value']

    ----- get_table_schema method: verbosity_level=1 -----
    sampletable0 OrderedDict([('attr_a', 'INTEGER'), ('attr_b', 'INTEGER')])
    sampletable1 OrderedDict([('foo', 'INTEGER'), ('bar', 'REAL'), ('hoge', 'TEXT')])
    constraints OrderedDict([('primarykey_id', 'INTEGER'), ('notnull_value', 'REAL'), ('unique_value', 'INTEGER')])


Dump SQLite Schema as Table Text
----------------------------------

.. code:: python

    for verbosity_level in range(2):
        print("----- dump schema table: verbosity_level={} -----".format(
            verbosity_level))
        extractor = sqliteschema.SqliteSchemaExtractor(
            sqlite_db_path, verbosity_level=verbosity_level,
            output_format="table")
        print(extractor.dumps())

.. code::

    ----- dump schema table: verbosity_level=0 -----
    .. table:: sampletable0

        +--------------+---------+
        |Attribute name|Data type|
        +==============+=========+
        |attr_a        |INTEGER  |
        +--------------+---------+
        |attr_b        |INTEGER  |
        +--------------+---------+

    .. table:: sampletable1

        +--------------+---------+
        |Attribute name|Data type|
        +==============+=========+
        |foo           |INTEGER  |
        +--------------+---------+
        |bar           |REAL     |
        +--------------+---------+
        |hoge          |TEXT     |
        +--------------+---------+

    .. table:: constraints

        +--------------+---------+
        |Attribute name|Data type|
        +==============+=========+
        |primarykey_id |INTEGER  |
        +--------------+---------+
        |notnull_value |REAL     |
        +--------------+---------+
        |unique_value  |INTEGER  |
        +--------------+---------+


    ----- dump schema table: verbosity_level=1 -----
    .. table:: sampletable0 (2 records)

        +--------------+---------+-----------+--------+------+-----+
        |Attribute name|Data type|Primary key|Not NULL|Unique|Index|
        +==============+=========+===========+========+======+=====+
        |attr_a        |INTEGER  |           |        |      |     |
        +--------------+---------+-----------+--------+------+-----+
        |attr_b        |INTEGER  |           |        |      |     |
        +--------------+---------+-----------+--------+------+-----+

    .. table:: sampletable1 (2 records)

        +--------------+---------+-----------+--------+------+-----+
        |Attribute name|Data type|Primary key|Not NULL|Unique|Index|
        +==============+=========+===========+========+======+=====+
        |foo           |INTEGER  |           |        |      |X    |
        +--------------+---------+-----------+--------+------+-----+
        |bar           |REAL     |           |        |      |     |
        +--------------+---------+-----------+--------+------+-----+
        |hoge          |TEXT     |           |        |      |X    |
        +--------------+---------+-----------+--------+------+-----+

    .. table:: constraints (0 records)

        +--------------+---------+-----------+--------+------+-----+
        |Attribute name|Data type|Primary key|Not NULL|Unique|Index|
        +==============+=========+===========+========+======+=====+
        |primarykey_id |INTEGER  |X          |        |      |     |
        +--------------+---------+-----------+--------+------+-----+
        |notnull_value |REAL     |           |X       |      |     |
        +--------------+---------+-----------+--------+------+-----+
        |unique_value  |INTEGER  |           |        |X     |     |
        +--------------+---------+-----------+--------+------+-----+


Dump Schema as Text
---------------------------

.. code:: python

        for verbosity_level in range(6):
            print("----- dump schema text: verbosity_level={} -----".format(
                verbosity_level))
            extractor = sqliteschema.SqliteSchemaExtractor(
                sqlite_db_path, verbosity_level=verbosity_level,
                output_format="text")
            print(extractor.dumps())

.. code::

    ----- dump schema text: verbosity_level=0 -----
    sampletable0
    sampletable1
    constraints

    ----- dump schema text: verbosity_level=1 -----
    sampletable0 (attr_a, attr_b)
    sampletable1 (foo, bar, hoge)
    constraints (primarykey_id, notnull_value, unique_value)

    ----- dump schema text: verbosity_level=2 -----
    sampletable0 (attr_a INTEGER, attr_b INTEGER)
    sampletable1 (foo INTEGER, bar REAL, hoge TEXT)
    constraints (primarykey_id INTEGER, notnull_value REAL, unique_value INTEGER)

    ----- dump schema text: verbosity_level=3 -----
    sampletable0 (attr_a INTEGER, attr_b INTEGER)
    sampletable1 (foo INTEGER, bar REAL, hoge TEXT)
    constraints (primarykey_id INTEGER PRIMARY KEY, notnull_value REAL NOT NULL, unique_value INTEGER UNIQUE)

    ----- dump schema text: verbosity_level=4 -----
    sampletable0 (
        attr_a INTEGER,
        attr_b INTEGER
    )

    sampletable1 (
        foo INTEGER,
        bar REAL,
        hoge TEXT
    )

    constraints (
        primarykey_id INTEGER PRIMARY KEY,
        notnull_value REAL NOT NULL,
        unique_value INTEGER UNIQUE
    )


    ----- dump schema text: verbosity_level=5 -----
    sampletable0 (
        attr_a INTEGER,
        attr_b INTEGER
    )

    sampletable1 (
        foo INTEGER,
        bar REAL,
        hoge TEXT
    )
    CREATE INDEX sampletable1_foo_index ON sampletable1('foo')
    CREATE INDEX sampletable1_hoge_index ON sampletable1('hoge')

    constraints (
        primarykey_id INTEGER PRIMARY KEY,
        notnull_value REAL NOT NULL,
        unique_value INTEGER UNIQUE
    )


Dependencies
============

Python 2.7+ or 3.3+

- `logbook <http://logbook.readthedocs.io/en/stable/>`__
- `pytablewriter <https://github.com/thombashi/pytablewriter>`__
- `SimpleSQLite <https://github.com/thombashi/SimpleSQLite>`__
- `six <https://pypi.python.org/pypi/six/>`__
- `typepy <https://github.com/thombashi/typepy>`__

Test dependencies
-----------------

-  `pytest <https://pypi.python.org/pypi/pytest>`__
-  `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
-  `tox <https://pypi.python.org/pypi/tox>`__


