sphinxcontrib-htsql 0.1.5

概述

sphinxcontrib-htsql 是一个扩展，可以将 HTSQL 查询嵌入到 Sphinx 文档中。

您可以在 http://htsql.org/doc/overview.html#htsql-in-a-nutshell 中看到此扩展的实际应用。更多示例，请参阅源分发中的 demo 目录。

此软件由 Kirill Simonov (Prometheus Research, LLC) 编写，并使用BSD许可证发布。

使用方法

要启用此扩展，请将以下行添加到 conf.py

extensions.append('sphinxcontrib.htsql')

您还需要指定HTSQL服务的地址

htsql_root = 'http://demo.htsql.org'

现在，您可以使用 htsql 指令将HTSQL查询添加到任何Sphinx文档中

.. htsql:: /school?campus='old'

此指令执行查询，并插入一个包含查询字符串和查询输出的表格块

如果查询跨越多行，则可以在指令体中编写

.. htsql::

   /school.define(num_dept := count(department))
          {code, num_dept}?num_dept>3

如果您想显示一个查询的输出与另一个查询的输出，请使用 output 选项。这对于描述破坏性操作、尚未实现的功能或逃避规则很有用。您需要手动引用空白字符和特殊字符

.. htsql:: /school?campus='north'
   :output: /school?campus='south'

通常，htsql 指令期望查询有效。使用 error 选项来指示查询无效并且你想要显示错误消息

.. htsql:: /school{code, title}
   :error:

通常，查询会渲染成一个链接，链接到 HTSQL 服务。使用 no-link 选项来禁用此功能

.. htsql:: /school?exists(department)
   :no-link:

使用 no-output 选项来渲染查询，但不渲染输出

.. htsql:: /school[ns]
   :no-output:

使用 no-input 选项来渲染查询输出，但不渲染查询本身

.. htsql:: /school[ns]
   :no-input:

通常，查询输出以表格的形式渲染。使用选项 raw 来以未格式化的形式渲染输出

.. htsql:: /school[ns]/:json
   :raw:

使用 cut 选项截断查询输出到指定的行数。此选项适用于表格和原始输出

.. htsql:: /school
   :cut: 3

参考