newt.qbe 0.1.1

sql(query, order_by=())

返回PostgreSQLWHERE子句的内容（以字节形式）。

通过组合查询中给出的表达式返回SQL布尔表达式。如果查询为空，则返回'true'。

查询参数必须是一个映射对象。键也必须在QBE中存在。值（格式由助手特定）传递给助手的__call__方法。

order_by参数是一个排序条件的可迭代对象。项目可以是助手名称或包含助手名称和降序标志的两个元组。

为了说明用法，以下是使用概述部分中创建的QBE对象的一些示例

>>> qbe.sql(conn, dict())
b'true'

>>> print(qbe.sql(conn, dict(text='database', path='/wiki'),
...               order_by=[('stars', True), 'text']).decode('ascii'))
(((state ->> 'path') || '/') like '/wiki' || '/%') AND
  content_text(state) @@ to_tsquery('english', 'database')
ORDER BY (state->'rating'->>'stars')::int DESC,
  ts_rank_cd(array[0.1, 0.2, 0.4, 1], content_text(state), to_tsquery('english', 'database'))

index_sql(*names)

返回用于为给定助手创建索引的PostgreSQL文本列表。如果没有指定助手，则返回所有助手的语句（实现可选的index_sql方法的助手）。

>>> for sql in qbe.index_sql():
...     print(sql)
CREATE INDEX CONCURRENTLY newt_email_idx ON newt ((state ->> 'email'))
CREATE INDEX CONCURRENTLY newt_keywords_idx ON newt USING GIN ((state -> 'keywords'))
CREATE INDEX CONCURRENTLY newt_path_idx ON newt (((state ->> 'path') || '/') text_pattern_ops)
CREATE INDEX CONCURRENTLY newt_stars_idx ON newt (((state->'rating'->>'stars')::int))
CREATE INDEX CONCURRENTLY newt_text_idx ON newt USING GIN (content_text(state))

返回列表是因为需要单独执行这些语句（因为使用了CONCURRENTLY）。

match(name, convert=None)

匹配命名标量值（使用JSONB @>运算符）。这利用了Newt数据库默认创建的JSON GIN索引。它不支持范围搜索。

scalar(expr, type=None, convert=None)

scalar助手根据标量值进行搜索。构造函数接受一个产生文本结果的表达式。为了方便起见，如果提供了一个标识符（例如'email'），则它将被计算为访问顶级属性的表达式。为了方便起见，如果提供了一个简单的JSON访问器表达式，如

state -> 'x' -> 0

它将被修改以产生文本结果

state -> 'x' ->> 0

您还可以提供一个可选的第二个参数，给出将文本值转换为的PostgreSQL数据类型的名称。

可选的 convert 参数提供了一个可调用的函数，用于将查询值转换为可以传递给 psycopg2 游标 mogrify 方法的值。

text_array(expr, convert=None)

array 辅助函数基于文本数组值进行搜索。构造函数接受一个表达式，该表达式产生一个 PostgreSQL 文本数组。

搜索基于重叠。如果搜索值与给定的查询值有共同元素，则满足搜索条件。例如，查询 ['a', 'b'] 与 PostgreSQL 数组 ['a', 'c'] 匹配。

可选的 convert 参数提供了一个可调用的函数，用于将查询值转换为可以传递给 psycopg2 游标 mogrify 方法的值。

prefix(expr, delimiter=None, convert=None)

prefix 辅助函数支持对标量文本值进行前缀查询。这通常用于路径搜索。

构造函数接受一个表达式，该表达式产生一个文本结果。与标量辅助函数一样，如果需要，标识符或 JSON 访问器将被转换为表达式。

可以提供一个可选的第二个参数，给出路径分隔符。如果提供了，分隔符将包含在 like 查询中。如果从标识符或更简单的 JSON 访问器生成表达式，则分隔符也将包含在生成的表达式中。

可选的 convert 参数提供了一个可调用的函数，用于将查询值转换为可以传递给 psycopg2 游标 mogrify 方法的值。

fulltext(expr, config, parer=None, weights=(.1, .2, .4, 1.0))

fulltext 辅助函数支持全文搜索。构造函数接受一个表达式，该表达式评估为 PostgreSQL ts_vector 以及一个 测试搜索配置 的名称。

为了方便，如果提供了一个标识符或 JSON 访问器（例如 state -> 'x' -> 0），则会生成一个 tsvector 表达式。

在搜索时，查询作为字符串提供，并传递给 to_tsquery。可以提供一个可选的查询解析函数来转换搜索查询。

如果使用文本辅助函数进行排序，则将使用提供的权重调用 ts_rank_cd 函数。

sql(cond, order=None, convert=None)

sql 辅助函数提供了一种将任意 SQL 封装为搜索辅助函数的方法。构造函数接受一个字符串 SQL 表达式，用于在搜索时使用。该字符串应包含一个用于替换查询数据的单个 占位符。

可以提供一个可选的第二个参数，用于排序的 SQL 表达式。

可选的 convert 参数提供了一个可调用的函数，用于将查询值转换为可以传递给 psycopg2 游标 mogrify 方法的值。

0.1.1 (2017-06-21)

• 修复了在排序时使用全文索引导致生成无效 SQL 的 sql 生成错误。

0.1.0 (2017-04-26)

初始发布