A flask blueprint providing a read-lny API for querying RDBMS
Project description
apisql
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_ROWSor 100. - page_size: The size of the 'page', when doing paging. By default will use
num_rowsand in any way the page size it won't exceednum_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
csvorxlsx. Defaults tocsv. -
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 stringsyesno, 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/'
)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file apisql-0.3.7.tar.gz.
File metadata
- Download URL: apisql-0.3.7.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c4cd4aa8bc291c3c60b3fa8c7ab3dd469bcf70f30d23d2097d871cf5a9c010ea |
|
| MD5 | 372114aea0d172724e375e48b0f80376 |
|
| BLAKE2b-256 | eefcc77c96f3c51642d0da0536aae6cf159b44213cfc876e5a6019bfcb5384b2 |
Provenance
File details
Details for the file apisql-0.3.7-py2.py3-none-any.whl.
File metadata
- Download URL: apisql-0.3.7-py2.py3-none-any.whl
- Upload date:
- Size: 19.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 437911e8d618a2bab430bdc0452cfbda81795d4f231b8d5e7d62f4830822a844 |
|
| MD5 | bb5a6b1c59124596544f189d79784b25 |
|
| BLAKE2b-256 | 7db5652503b240e5e41c554b3479ff531b23195fcfbc4bba6c22e8974db5175e |
