Skip to main content

A Database Query Language (Django gateway)

Project description

HTSQL is a comprehensive navigational query language for relational databases. This package contains a Django application that provides a gateway to HTSQL service.

This is an experimental package. The usage, API, and security assumptions may change in future releases.

For more information on HTSQL, please see:

http://htsql.org/

The HTSQL homepage

http://pypi.python.org/pypi/HTSQL/

The source package for HTSQL

Installation and Usage

This package allows you to use HTSQL in your Django projects. To install it, run:

# pip install HTSQL-DJANGO

This command installs HTSQL itself and a Django gateway. Out of the box, HTSQL works with SQLite databases. To run HTSQL on top of other database servers, install additional database backends:

# pip install HTSQL-PGSQL
# pip install HTSQL-MYSQL

To use HTSQL in your Django project, open settings.py and add 'htsql_django' to the list of installed applications:

INSTALLED_APPS = (
    # ...
    'htsql_django',
)

When used in a Django project, HTSQL service is automatically configured to serve on the default Django database. You could provide additional configuration options using parameter HTSQL_CONFIG. For instance, a reasonable configuration could be:

HTSQL_CONFIG = {
    # Set query timeout in seconds (currently, PostgreSQL only).
    'tweak.timeout': { 'timeout': 600 },
    # Set the maximum number of output rows.
    'tweak.autolimit': { 'limit': 10000 },
    # Enable the web-based query editor.
    'tweak.shell.default': {},
    # Enable meta-data queries.
    'tweak.meta': {},
}

Next, add the gateway to the URL dispatcher. Open urls.py and add the following line:

urlpatterns = patterns('',
    # ...
    url(r'^htsql/', include('htsql_django.urls')),
)

This will forward HTTP requests starting from /htsql/ to the HTSQL service. The gateway is available only to authenticated users.

You could also make HTSQL queries from Python code. For example, to calculate the total number of votes per poll in the Django tutorial project, run:

>>> from htsql_django import produce
>>>
>>> query = "/polls_poll{question, total:=sum(polls_choice.votes)}"
>>> for row in produce(query):
...     print "%s: %s" % (row.question, row.total)
...
What's up?: 6

Project details


Download files

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

Source Distributions

HTSQL-DJANGO-2.3.1.zip (15.6 kB view details)

Uploaded Source

HTSQL-DJANGO-2.3.1.tar.gz (9.9 kB view details)

Uploaded Source

File details

Details for the file HTSQL-DJANGO-2.3.1.zip.

File metadata

  • Download URL: HTSQL-DJANGO-2.3.1.zip
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for HTSQL-DJANGO-2.3.1.zip
Algorithm Hash digest
SHA256 f94d18674718d53c80dc465ed1cd29dda59d7d5d507a245799dcfae9961c49ef
MD5 44e690e5a433c3a9fdf4ea8652613862
BLAKE2b-256 852204f7cbe12b5bca74f6b42bfc7de667a8164b1c797ab4526298d78eba0651

See more details on using hashes here.

File details

Details for the file HTSQL-DJANGO-2.3.1.tar.gz.

File metadata

File hashes

Hashes for HTSQL-DJANGO-2.3.1.tar.gz
Algorithm Hash digest
SHA256 68c0414f7ce59e67e3d1bf7b39a4fbceba380a543b956eeee64612d5f91cd794
MD5 807e45e2b559670295c0649c2890c45b
BLAKE2b-256 5ddeb0e46758995bf3d7d820b159001a72a4576d22dc46b979b12ad9b830fe8d

See more details on using hashes here.

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