@ sposter/ azure (英语)
它持有一个真正的客户和一个假客户都必须遵循的Azure电线惯例. 它们是表存储和搜索共用的OData过滤条款词汇、实体密钥外壳惯例和服务限制.
设计笔记在现场 规格。 。 。 .
目录
开始
安装软件包 :
pnpm add @esposter/azure
QQ 密钥导出
| 导出 | 仁爱 | 目的 |
|---|---|---|
AZURE_MAX_PAGE_SIZE | 针头 | 一个呼叫中服务返回的最大页面大小 |
BinaryOperator | 语句 | 比较运算符表存储理解 |
Clause | 类型 | 一个属性的过滤条件,单元OData字符串从 |
CompositeKey | 类 | 这个 partitionKey 财务报告和审定财务报表 rowKey 每个表格实体携带的配对 |
CompositeKeyPropertyNames | 针头 | 这个 CompositeKey 属性名称,所以调用者不会重述字符串 |
deserializeClause | 函数 | 将一个序列化过滤器条款重新解析为 a Clause,没有匹配 |
escapeValue | 函数 | 引用一个字符串作为 OData 字元,双倍嵌入式单引号 |
getPartitionKeyFilter | 函数 | 过滤器在一个分区键下选择一切 |
getTableNullClause | 函数 | 表格存储“ 无效” 条款, a 无效 NaN 比较 |
SearchOperator | 语句 | 仅支持 Azure 搜索的收藏上游 |
serializeClauses | 函数 | 将条款序列化为表格存储 OData 过滤字符串 |
serializeValue | 函数 | 一号 SerializableValue 作为表格或搜索的文字 |
条款
A 类 Clause<T> 是对属性的过滤条件 T。OData 字符串由条款构建。 不要用手组装字符串.
BinaryOperator保留表格存储所理解的比较.SearchOperator保存只有 Azure 搜索支持的收藏上游.UnaryOperator合并条款.
import type { Clause } from "@esposter/azure";
import { BinaryOperator } from "@esposter/azure";
const clause: Clause<{ createdAt: Date }> = { key: "createdAt", operator: BinaryOperator.Ge, value: new Date(0) };
数值
serializeValue 制作一个 SerializableValue 以目标服务所期望的格式. isTableFilter 选择格式.
- 表格存储: a
Date作为datetime'<iso>'字义. - 搜索: a
Date将 ISO 字符串变为空 .
字符串通过 escapeValue。它将每个嵌入式单引文翻倍,因此一个值不能关闭自己的字元或添加自己的过滤语法.
import { escapeValue, serializeValue } from "@esposter/azure";
过滤器
serializeClauses 将条款数组转换为表格存储过滤字符串. serializeSearchClauses 将条款数组转换为搜索过滤字符串。 二人之间只有不同 Date 使。 。 .
关于同一钥匙的条款归为一类:
- 区域配对与
and。 。 。 . - 任何其他组被加入
or。 。 。 .
不用手组装布尔结构 . deserializeClause 即为逆相.
import { BinaryOperator, CompositeKeyPropertyNames, getTableNullClause, serializeClauses } from "@esposter/azure";
const roomId = crypto.randomUUID();
const filter = serializeClauses([
{ key: CompositeKeyPropertyNames.partitionKey, operator: BinaryOperator.Eq, value: roomId },
getTableNullClause("deletedAt"),
]);
这两个部门处理的完全不一样。 助道者治取差别.
getTableNullClause表示表存储“是无效的”.- 直接搜索支持无效, 通过
getSearchNullClause编号 :getSearchNonNullClause。 。 。 .
getPartitionKeyFilter 构建在一个分区密钥下选择所有内容的一幕过滤器 。 读取、计数和清理同一个实体都必须从这个过滤器开始.
密钥
CompositeKey 这是 partitionKey编号 :rowKey 每个表格实体所携带的对子。 通过 CompositeKeyPropertyNames不要重述字符串. serializeKey 财务报告和审定财务报表 deserializeKey 转换边界上的密钥.
import { CompositeKey, CompositeKeyPropertyNames, serializeKey } from "@esposter/azure";
限制
这些常数持有服务允许的最大值: AZURE_MAX_BATCH_SIZE, (中文(简体) ), AZURE_MAX_PAGE_SIZE 财务报告和审定财务报表 AZURE_MAX_QUEUE_VISIBILITY_TIMEOUT_MS。使用它们时,您会标注、批量或排队。 不要硬码这些值 .
许可证
本项目根据以下规定获得许可证: Apache-2.0 许可证。 。 。 .