サンプルアプリツアー
SQLly Embedded に同梱されているサンプル管理アプリを画面ごとに案内するツアー: ステータスとライセンス、プロファイルと接続、ラベル、ユーザー、SQLly の起動。
パッケージには、小さな管理アプリが付属しています (sample-app/、Node.js 20+、依存関係なし)で、SQLly Embedded でできることをすべて試せます。次の役割を果たします: あなたの アプリ: プロファイル、ラベル、ユーザーを管理する管理者側と、ユーザーをサインインさせてSQLlyを開くユーザー側。以下の各画面は、1つか2つの 管理 API 各スクリーンショットの下に名前が表示されている呼び出しで、自分のアプリが何を呼び出すことになるかがわかります。
これらのスクリーンショットは、試用ライセンスに紐付けた実際のブリッジと、その先にある SQL Server の Northwind データベースで撮ったものです。
管理者サインイン
ステータスとライセンス
ステータス です GET /manage/status ページとして表示されます。キーやライセンスファイルなしで起動したブリッジは、 ライセンスなし: プロファイルの作成とテストはすでに行えますが、インストールがリンクされるまで SQLly は起動しません。
sqlly.app に接続 sqlly.appにリンクコードを要求します(POST /api/embedded/links)、それを表示します。 承認するには sqlly.app を開いてください ライセンス所有者を sqlly.app に案内します。そこで同じコードを確認し、ライセンスを選択します:
数秒後、管理者アプリがインストールのキーを受け取り、次のコマンドでブリッジに渡します PUT /manage/license、「Status」にはライセンスが表示されます:
プロファイル
プロファイルは、ユーザーのグループに表示される接続のセットです。リストには、各プロファイルの接続と、そのプロファイルが割り当てられているユーザーが表示され、 起動 そのプロファイルで自分として SQLly を開くには。
接続を編集する
接続エディターは、選択したエンジンで資格情報形式がサポートするすべてのフィールドを提供します。エンジンの一覧と各エンジンのサインイン方式は、次から取得されます GET /manage/engines. テスト フォームの現在の内容を、保存済みかどうかにかかわらずチェックし、エンジン本来の応答をインラインで表示します:
ラベル
SQLly では、クライアント、プロジェクト、環境が接続に色を付けてグループ化し、安全ルールを持たせます。サンプルアプリは共有セットを 1 つ保持してすべてのプロファイルと一緒に送信するため、ラベルの名前を変更すると、それを使うすべての接続が更新されます。
ユーザーとシート
サンプルアプリのユーザーは独自のアカウントで、それぞれ 1 つのプロファイルが割り当てられています。皆さんのアプリでは、ユーザーとそのアクセス権は既存のものがそのまま使われます。このページには、現在シートを占有しているユーザーも表示されます(GET /manage/seats)。次を使用し、 シートを解放 (DELETE /manage/seats/{user}).
ユーザーが見るもの
ユーザーは /admin ではなく、アプリのルートでサインインします:
SQLly を開いている間、「ステータス」には使用中のシートが表示されます:
コードの読み方
| ファイル | そこから得られること |
|---|---|
lib/bridge.js | 完全な管理 API クライアント:すべての呼び出し、エラー処理、タイムアウトを含みます。コピーするか、移植して使ってください。 |
lib/credentials.js | フォームのフィールドと共有ラベルを次に変換します sqlly-credentials ドキュメント。 |
lib/sqllyapp.js | リンク処理の sqlly.app 側: リンクを作成し、キーをポーリングします。 |
server.js | ルーティング。 GET /app/ は起動経路です; /admin/* は管理者側です。 /admin/link* はリンクしています。 |
views/pages.js | HTML(次を含む): injectLaunch、次の前に 2 つのグローバルを設定します boot.js. |
test/ | node --test アプリを偽のブリッジに対して実行するテストスイート。独自の連携をテストする際の良い見本になります。 |
置き換える準備はできましたか? 独自のアプリをビルド お使いのスタックでこれらの各ジョブを順を追って解説します。