Skip to main content

A flask blueprint providing a read-lny API for querying RDBMS

Project description

apisql

PyPI - Python Version

apisql is a flask blueprint providing an API for read-only access for a DBMS using direct SQL Queries

endpoints

/query

Returns query results in json format.

Query parameters that can be send:

  • query: The SQL query to execute on the DB. The query can be provided in plain text or base64 encoded.
  • num_rows: The maximum number of rows to return. If not specified, will return the aount defined in the configuration, the amount defined in the environment variable APISQL__MAX_ROWS or 100.
  • page_size: The size of the 'page', when doing paging. By default will use num_rows and in any way the page size it won't exceed num_rows.
  • page: Which page to fetch, starting from page 0

/download

Downloads query results in either csv, xls or xlsx format.

Query parameters that can be send:

  • query: The SQL query to execute on the DB. The query can be provided in plain text or base64 encoded.

  • format: Either csv or xlsx. Defaults to csv.

  • filename: The filename for the file to be downloaded, without the extension. Defaults to query-results.

  • headers: A semicolon separated list of the headers for the output file. Headers should match the field names that appear in the query. Headers may contain one or more modifiers, which appear after a colon. The currently supported modifiers are:

    • number, to convert numeric values to strings
    • yesno, which converts boolean values to "Yes" / "No"
    • comma-separated, which converts arrays of strings to a comma separated list of these strings. Finally, the content for a column may be fetched from a different field in the query output, by specifying the field name after a < character.

    Example: Fiscal Year:number<fiscal_year;Leap Year:yesno<0;

Example: For the following SQL:

select employee_name as "Employee Name", employee_salary as "Salary", is_manager as "Managerial role?" from employees

headers could be specified as Employee Name;Managerial role?:yesno;Salary:number.

configuration

Flask configuration for this blueprint:

    from apisql import apisql_blueprint

    app.register_blueprint(
        apisql_blueprint(connection_string='psql://host/database', max_rows=1000, debug=False),
        url_prefix='/api/db/'
    )

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apisql-0.2.8.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

apisql-0.2.8-py2.py3-none-any.whl (19.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file apisql-0.2.8.tar.gz.

File metadata

  • Download URL: apisql-0.2.8.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.4

File hashes

Hashes for apisql-0.2.8.tar.gz
Algorithm Hash digest
SHA256 154ce083d2aa9907b425b05b2a06f548bcaddaec55f1169fe270ee8810aa6205
MD5 54270e11433010c9ff353d65f5724378
BLAKE2b-256 5dcea995e47bb607fd66769fc1af0322667ba9a6fd455f8f397dd52e23b5d789

See more details on using hashes here.

Provenance

File details

Details for the file apisql-0.2.8-py2.py3-none-any.whl.

File metadata

  • Download URL: apisql-0.2.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 19.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.4

File hashes

Hashes for apisql-0.2.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 48437698fd5ff54bfb32a87a835075f4fe3b05c235a40e40a1c984a7b8611ef6
MD5 93729938c764d034b009a989cae9345b
BLAKE2b-256 6dfa0c074d97a106a268908183876fc16d61863b5b0d7a55cd8c10666ac24db6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page