agate-sql 0.1.0 (alpha)

About

agate-sql adds SQL read/write support to agate.

Important links:

Install

To install:

pip install agatesql

For details on development or supported platforms see the agate documentation.

Usage

agate-sql uses agate’s monkeypatching pattern to automatically add SQL support to all agate.Table instances.

import agate
import agatesql

Once imported, you’ll be able to use TableSQL.from_sql() and TableSQL.to_sql() as though they are members of agate.Table.

To import a table named doctors from a local postgresql database named hospitals you would run:

new_table = agate.Table.from_sql('postgresql:///hospitals', 'doctors')

To save this table back to the database:

new_table.to_sql('postgresql:///hospitals', 'doctors')

The first argument to either function can be any valid sqlalchemy connection string. The second argument must be a database name. (Arbitrary SQL queries are not supported.)

That’s all there is to it.

API

class agatesql.table.TableSQL
classmethod from_sql(connection_or_string, table_name)

Create a new agate.Table from a given SQL table. Types will be inferred from the database schema.

Monkey patched as class method Table.from_sql().

Parameters:
  • connection_or_string – An existing sqlalchemy connection or a connection string.
  • table_name – The name of a table in the referenced database.
to_sql(connection_or_string, table_name)

Write this table to the given SQL database.

Monkey patched as instance method Table.to_sql().

Parameters:
  • connection_or_string – An existing sqlalchemy connection or a connection string.
  • table_name – The name of the SQL table to create.

Authors

The following individuals have contributed code to agate-sql:

  • Christopher Groskopf

License

The MIT License

Copyright (c) 2015 Christopher Groskopf and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

0.1.0

  • Initial version.

Indices and tables