使用Hexabase TypeScript SDK从数据存储中获取数据

1 年 ago

逸, 科

1 minute

Hexabase为企业提供可放心使用的BaaS（后端即服务）。与其他许多BaaS一样，我们主要希望前端开发人员使用。因此，我们目前正在开发TypeScript SDK。

本文介绍了Hexabase TypeScript SDK的安装以及从数据存储区获取数据的方法。

安裝

通过使用npm或yarn来进行安装。

# npmの場合
npm install @hexabase/hexabase-js

# yarnの場合
yarn add @hexabase/hexabase-js

引入

当你进行导入，你可以得到一个叫做 HexabaseClient 的对象。

import { HexabaseClient } from "@hexabase/hexabase-js";

进行初始化

初始化HexabaseClient。

const client = new HexabaseClient();

验证

在Hexabase中，由于是为了商业用途而构建的，因此在使用时需要使用认证信息。首先需要通过电子邮件和密码进行身份验证，然后使用令牌访问GraphQL。使用客户端来进行处理。

最初的认证方式如下：需要提供电子邮件和密码，或者令牌。

client.login({email, password, token});

接下来，针对这个客户进行处理。

对于访问数据存储时所需的信息

访问数据存储时，需要以下信息。

（オプション）プロジェクトID projectId

在进行进一步数据提取时，可以指定参数(params)来获取信息（如页数、获取数量等）。以下是访问示例。

const project = client.currentWorkspace.project(projectId);
const datastore = project.datastore(datastoreId);
const params = {}; // 検索条件用
const result = await datastore.items(params);

参数可以指定以下信息。

パラメータ名型必須意味per_page数値○検索結果の件数(省略、または、0を指定すると、全件取得されます）page数値○ページ数（省略すると1）conditionsSearchCondition型の配列
検索条件を指定use_or_condition真偽値
conditionsの条件に対してOR条件で検索します（falseまたは指定しない場合は、AND条件が適用されます）unread_only真偽値
trueを指定すると、「未読履歴をもつItem」のみの絞込条件がconditionsへ追加されます。sort_field_id文字列
ソートするフィールドIDを指定(ソートキーが1fieldのみの場合)sort_order文字列
昇順の場合”asc” 降順の場合”desc”(ソートキーが1fieldのみの場合)sort_fieldsSortField型
ソートキーが複数ある場合に指定します。 sort_field_idに優先してソートに利用されます。use_default_search真偽値
true or false デフォルト検索条件(注)を適用する場合、trueを指定include_links真偽値
true を指定すると、関連するアイテムのIDの配列を取得できますinclude_lookups真偽値
true を指定すると、データベース参照型の参照先アイテム情報を結果に含めますreturn_count_only真偽値
trueを指定すると、totalItemsのみ返却します。itemsは[] (空配列)となります。omit_fields_data真偽値
結果から、fieldsの情報を含めません。（不要な通信データ量を省略できます）omit_total_items真偽値
trueを指定すると、totalItemsをカウントしません（より高速になります） totalItemsは0となります。data_result_timeout_sec数値
一覧結果取得までのタイムアウト秒数を指定します。タイムアウトした場合は、itemsは[] (空配列)となります。total_count_timeout_sec数値
件数取得までのタイムアウト秒数を指定します。タイムアウトした場合は-1が返ります。return_number_value真偽値
true を指定すると、数値型データがNumberとして出力されます（defaultでは、数値は文字列(“123”)で返却される）

搜索条件类型

用于指定搜索条件。

パラメータ名型必須意味search_valueJSON
検索する値に合わせたJSONフォーマットdata_type文字列
日付の場合のフォーマットを指定id文字列
フィールドIDrpf_id文字列
レポートフィールドIDexact_match真偽値
完全一致とする場合は truenot_match真偽値
不一致判定用のフラグinclude_null真偽値
nullを許容するかどうかconditionsSearchCondition型
検索を入れ子に行う場合use_or_condition真偽値
conditionsの条件に対してOR条件で検索します（falseまたは指定しない場合は、AND条件が適用されます）

排序字段类型

请在对搜索结果进行排序时进行指定。

パラメータ名型必須意味id文字列
フィールド画面IDorder文字列
asc（昇順）またはdesc（降順）

作为一个例子，可以如下所示。

 [
	{ id: "FIELD_A", order: "asc"},
	{ id: "FIELD_B", order: "desc"}
]

在中文中，只需要一個選項重新表達以下內容：使用id來設定欄位畫面ID，使用order來指定排序順序。如果省略order，則以升序（asc）排列。它將按照指定的順序應用為第一排序鍵和第二排序鍵。

总结

如果您使用Hexabase TypeScript SDK，您可以快速开发与Vue、React等框架集成的Web应用程序。截至2023年04月，我们正在积极开发中，请务必尝试并提供反馈，我们将不胜感激！

六进制基/六进制基-中国