LoginSignup
0
0

Hexabase TypeScript SDKでのワークスペース・プロジェクト・データストアを名前で取得できます

Posted at

Hexabaseは企業においても安心して利用できるBaaS(Backend as a Service)を提供しています。多くのBaaSがそうであるように、主にフロントエンド開発者に利用してもらいたいと考えています。そこで現在、TypeScript SDKの開発が進められています。

@hexabase/hexabase-js - npm

この記事では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の中で、最上位のオブジェクトです。従来、ワークスペースを取得する際にはワークスペースIDを使っていました。ワークスペースIDは 6513e1c97f90e97937eb9eef のようなユニークな文字列です。

await client.setWorkspace("6513e1c97f90e97937eb9eef");

このワークスペースIDはHexabase管理画面のURLから取得できます。

https://app.hexabase.com/h/6513e1c97f90e97937eb9eef // ← このID

これでは分かりづらいので、ワークスペース名を使って取得できるようになりました。

await client.setWorkspace("my_workspace");

このワークスペース名は、管理画面で設定するものです。

プロジェクトについて

ワークスペースは複数のプロジェクトを保有します。従来、このプロジェクトもプロジェクトIDを使って取得していました。

const project = await client.currentWorkspace.project("5f9e1c97f90e97937eb9eef");

こちらも同じく、管理画面で設定するプロジェクト名が利用できます。

const project = await client.currentWorkspace.project("my_project");

データストアについて

プロジェクトは複数のデータストア(RDDMSのテーブルに相当)を保有します。データストアもデータストアIDを使って取得していました。

const datastore = await project.datastore("5f9e1c97f90e97937eb9eef");

データストア名を使って取得できるようになりました。

const mainTable = await project.datastore("MainTable");

このように自分で設定した名前がそのまま使えるので、開発がスムーズに進められるでしょう。実際の流れは以下のようになります。

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

const client = new HexabaseClient();

await client.setWorkspace("my_workspace");
const project = await client.currentWorkspace.project("my_project");
const mainTable = await project.datastore("MainTable");

const item = await mainTable.item();

まとめ

Hexabase TypeScript SDKを使えば、VueやReactなどと連携したWebアプリを素早く開発できるようになります。2024年3月現在絶賛開発を進めていますので、ぜひ試していただいてフィードバックいただければ嬉しいです!

hexabase/hexabase-js

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0