一般的なカスタマイズ

Version 25.3.9411


一般的なカスタマイズ


データソーステーブルおよびストアドプロシージャは、シンプルかつ拡張が容易なテキストベースのスキーマで定義されています。これらの変更の多くは、API ページに移動し、変更が必要なスキーマへのリンクをクリックすることでAPI Server UI から行うことができます。または、編集が必要な.rsd ファイルまたは.rsb ファイルをテキストエディタで開きます。テーブルは.rsd ファイルに、ストアドプロシージャは.rsb ファイルに書き込まれます。これらのファイルは、アプリケーションルートのapi サブフォルダにあります。このトピックでは、.rsd ファイルを編集して一般的な変更を加える方法について説明します。

カラムの削除

api:info からattr エレメントを削除すると、テーブルからカラムが削除されます。これは、API がそのカラムをリストせず、キャッシュがそのカラムを含んでいないことを意味します。

重要:削除するカラムのXML エレメント全体を削除してください。

カラムのデータ型の変更

カラムのデータ型を変更するには、xs:type アトリビュートをサポートされているデータ型のいずれかに変更します:

  • string
  • datetime
  • boolean
  • int
  • long
  • double

カラム名の変更

カラムの名前を変更するには、新しいカラム名を含むalias アトリビュートを追加します。name アトリビュートを変更することはできません。API Server が基底となるデータソース内の正しいカラムへのマッピングを維持するには、この値の一貫性を維持する必要があります。

この例は、Type カラムをAPIsType にリネームします:

<api:info>
<attr name="Type" alias="APIsType" xs:type="string" columnsize="40" readonly="True" key="False" />
...
</api:info>

テーブル名の変更

テーブル名を変更するには、アプリケーションルートのapi サブフォルダ内にあるテーブル.rsd ファイルの名前を変更します。

Note:api:infotitle アトリビュートは、基底となるデータソースのテーブル名と同じでなければなりません。

データソース接続の変更

api:infoconnection アトリビュートを使って、テーブルやストアドプロシージャの接続の変更を行うことができます。これにより、Sandbox から運用インスタンスへの切り替えが簡単に行えます。

アプリケーションの接続ページで接続に加えた変更は、api:info で同じ接続を参照するすべてのテーブルおよびストアドプロシージャに反映されます。

<api:info title="case" description="Create, Update, Query, and Delete the SQLite Cars database." connection="SQLiteCars">
...
</api:info>