Kirill Simonov avatar Kirill Simonov committed 14bac1b Merge

Merged.

Comments (0)

Files changed (4)

doc/guide/config.rst

 
 .. htsql:: /meta(/link?table_name='course')
 
+You could also run ``/meta()`` on the meta-data schema, for example:
+
+.. htsql:: /meta(/meta(/table))
+
+
+``tweak.shell``
+---------------
+
+This extension module adds a command ``/shell()`` which takes any query
+and populates visual editor with syntax highlighting (using the
+excellent CodeMirror_ library).  As you modify the query, the URL
+changes so it can be bookmarked.
+
+The ``tweak.shell.default`` plugin will make ``/shell()`` the 
+default command, replacing the regular HTML output.
+
+.. _CodeMirror: http://codemirror.net/
 
 ``tweak.autolimit``
 -------------------
 a given number of ``timeout`` seconds (the default is 60s).  
 This plugin is currently only supported by PostgreSQL.
 
+``tweak.cors``
+--------------
 
-``tweak.shell``
----------------
+This plugin adds CORS headers in order to enable cross
+site scripting for public data servers.  This permits
+modern browsers to bypass JSONP and other hacks used
+to work around XSS protection.
 
-This extension module adds a command ``/shell()`` which takes any query
-and populates visual editor with syntax highlighting (using the
-excellent CodeMirror_ library).  As you modify the query, the URL
-changes so it can be bookmarked.
+``tweak.sqlalchemy``
+--------------------
 
-The ``tweak.shell.default`` plugin will make ``/shell()`` the 
-default command, replacing the regular HTML output.
+This plugin provides SQLAlchemy integration in two ways.
+First, if the dburi is omitted, it attempts to use the
+database connection from SQLAlchemy.  Secondly, it uses
+the SQLAlchemy model instead of introspecting.
 
-.. _CodeMirror: http://codemirror.net/
+``tweak.view``
+--------------
+
+This plugin attempts to guess at various links 
+between views and tables (where foreign keys are
+not defined).  This is only supported in PostgreSQL.
+
+``tweak.system``
+----------------
+
+This plugin adds the system catalog tables and links for the
+database's native system catalog.  This is supported only for
+PostgreSQL.
 
 .. vim: set spell spelllang=en textwidth=72:

src/htsql_tweak/inet/__init__.py

 class TweakINetAddon(Addon):
 
     name = 'tweak.inet'
+    hint = """adds support for inet data types"""
+    help = """
+      This plugin adds support for various internet data
+      types for PostgreSQL.
+    """
 
     @classmethod
     def get_extension(cls, app, attributes):

src/htsql_tweak/resource/__init__.py

 class TweakResourceAddon(Addon):
 
     name = 'tweak.resource'
+    hint = """static resource support"""
+    help = """
+      This plugin creates a mechanism for other plugins, such as
+      the ``tweak.shell`` to provide access to static resources
+      such as Javascript and CSS files. 
+    """
 
     parameters = [
             Parameter('indicator', StrVal(r'^[/]+$'), default='-'),

src/htsql_tweak/system/__init__.py

 class TweakSystemAddon(Addon):
 
     name = 'tweak.system'
+    hint = """direct access to system catalog"""
+    help = """
+      This plugin adds the system catalog tables and links 
+      for the database's native system catalog.  This is 
+      supported only for PostgreSQL.
+    """
 
     @classmethod
     def get_extension(cls, app, attributes):
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.