datasette/docs/index.rst
Simon Willison f6183ff5fa
Renamed --limit to --config, added --help-config, closes #274
Removed the --page_size= argument to datasette serve in favour of:

    datasette serve --config default_page_size:50 mydb.db

Added new help section:

    $ datasette --help-config
    Config options:
      default_page_size            Default page size for the table view
                                   (default=100)
      max_returned_rows            Maximum rows that can be returned from a table
                                   or custom query (default=1000)
      sql_time_limit_ms            Time limit for a SQL query in milliseconds
                                   (default=1000)
      default_facet_size           Number of values to return for requested facets
                                   (default=30)
      facet_time_limit_ms          Time limit for calculating a requested facet
                                   (default=200)
      facet_suggest_time_limit_ms  Time limit for calculating a suggested facet
                                   (default=50)
2018-05-20 10:01:49 -07:00

31 lines
635 B
ReStructuredText

Datasette
=========
*An instant JSON API for your SQLite databases*
Datasette provides an instant, read-only JSON API for any SQLite
database. It also provides tools for packaging the database up as a
Docker container and deploying that container to hosting providers such
as `Zeit Now`_ or `Heroku`_.
Some examples: https://github.com/simonw/datasette/wiki/Datasettes
Contents
--------
.. toctree::
:maxdepth: 2
getting_started
json_api
sql_queries
facets
full_text_search
metadata
config
custom_templates
plugins
changelog
.. _Zeit Now: https://zeit.co/now
.. _Heroku: https://www.heroku.com/