静的公開メンバ関数 | 全メンバ一覧
BRestful クラス

BRestful クラス。 [詳解]

#include <btrieveCpp.h>

静的公開メンバ関数

static const char * DELETE (const char *collectionName, int id=-1)
 コレクションまたはドキュメントを削除します。 [詳解]
 
static const char * GET (const char *collectionName, int id)
 ドキュメントを取得します。 [詳解]
 
static const char * GET (const char *collectionName, int id, char *blob, int blobSize, int documentBlobOffset=0, int documentBlobLength=0)
 ドキュメントを取得します。 [詳解]
 
static const char * GET (const char *collectionName, const char *query=NULL)
 ドキュメント ID を取得します。 [詳解]
 
static const char * POST (const char *collectionName, const char *json=NULL)
 コレクションまたはドキュメントを作成します。 [詳解]
 
static const char * POST (const char *collectionName, const char *json, const char *blob, int blobLength)
 コレクションまたはドキュメントを作成します。 [詳解]
 
static const char * PUT (const char *collectionName, int id, const char *json)
 ドキュメントを更新します。 [詳解]
 
static const char * PUT (const char *collectionName, int id, const char *json, const char *blob, int blobLength)
 ドキュメントを更新します。 [詳解]
 

詳解

BRestful クラス。

覚え書き
このクラスは現在ベータ リリースです。使用法に関するフィードバックや改善のためのご提案を求めておりますので、 https://communities.actian.com/s/actian-zen までお送りください。

BRestful クラスは RESTful HTTP API 開発者を対象としています。そのため、HTTP メソッドのサブセットがサポートされています。これらのメソッドには DELETE、GET、POST、および PUT があります。

HTTP メソッド BRestful メソッド 説明 必須パラメーター オプション パラメーター 戻り値
DELETE BRestful::DELETE コレクションを削除します コレクション名 ステータス
DELETE BRestful::DELETE ドキュメントを削除します コレクション名およびドキュメント ID ステータス
GET BRestful::GET コレクションを照会します コレクション名 クエリ ステータスおよびドキュメント ID の配列
GET BRestful::GET ドキュメントを取得します コレクション名およびドキュメント ID ユーザー BLOB バッファー ステータス、ドキュメントの JSON、およびオプションのドキュメント BLOB
POST BRestful::POST コレクションを作成します コレクション名 ステータス
POST BRestful::POST ドキュメントを作成します コレクション名およびドキュメントの JSON コンテンツ ドキュメントの BLOB コンテンツ ステータスおよびドキュメント ID
PUT BRestful::PUT ドキュメントを更新します コレクション名およびドキュメント ID ドキュメントの JSON および BLOB コンテンツ ステータス

すべてのメソッドは JSON を返します。 BtrieveCollection に挙げられている予約済み JSON フィールド名に加え、次の予約済み JSON フィールド名が定義されています。

フィールド名 ユーザー設定可能 説明
_collectionName いいえ 文字列 コレクション名
_ids いいえ 数値の配列 ドキュメント ID の配列
_statusCode いいえ 数値 ステータス コード
_statusString いいえ 文字列 ステータス文字列

BRestful::GETBRestful::POST 、および BRestful::PUT では、ユーザー設定可能でない JSON フィールド名があっても通知されません。 BtrieveCollection と上に挙げた以外の予約済み JSON フィールド名を使用すると、エラーが発生します。

参照
BtrieveCollection

関数詳解

◆ DELETE()

static const char* BRestful::DELETE ( const char *  collectionName,
int  id = -1 
)
static

コレクションまたはドキュメントを削除します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]idID。id が指定されていないか、または -1 である場合は、コレクションが削除されます。
戻り値
{
"_collectionName" : <collectionName>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。 コレクションが削除されました。
{
"_collectionName" : <collectionName>,
"_id" : <id>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。 ドキュメントが削除されました。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveClient::CollectionDelete BtrieveCollection::DocumentDelete Btrieve::StatusCode Btrieve::StatusCodeToString

◆ GET() [1/3]

static const char* BRestful::GET ( const char *  collectionName,
int  id 
)
static

ドキュメントを取得します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]idID。
戻り値
{
<documentJson>,
"_collectionName" : <collectionName>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveCollection::DocumentRetrieve Btrieve::StatusCode Btrieve::StatusCodeToString

◆ GET() [2/3]

static const char* BRestful::GET ( const char *  collectionName,
int  id,
char *  blob,
int  blobSize,
int  documentBlobOffset = 0,
int  documentBlobLength = 0 
)
static

ドキュメントを取得します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]idID。
[out]blobblob。
[in]blobSizeblob のサイズ。
[in]documentBlobOffsetドキュメントの blob のオフセット。
[in]documentBlobLengthドキュメントの blob の長さ。
戻り値
{
<documentJson>,
"_collectionName" : <collectionName>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveCollection::DocumentRetrieve Btrieve::StatusCode Btrieve::StatusCodeToString

◆ GET() [3/3]

static const char* BRestful::GET ( const char *  collectionName,
const char *  query = NULL 
)
static

ドキュメント ID を取得します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]queryクエリ。
戻り値
{
"_collectionName" : <collectionName>,
"_ids" : [ <id> ... ],
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveCollection::Query Btrieve::StatusCode Btrieve::StatusCodeToString

◆ POST() [1/2]

static const char* BRestful::POST ( const char *  collectionName,
const char *  json = NULL 
)
static

コレクションまたはドキュメントを作成します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]jsonjson。json が指定されていないか、または NULL である場合は、コレクションが作成されます。
説明
コレクションの作成によって既存のコレクションは上書きされません。既存のコレクションは最初に削除しておく必要があります。 BRestful::DELETE を参照してください。
ドキュメントを作成するには、まず、含まれるコレクションが存在している必要があります。
戻り値
{
"_collectionName" : <collectionName>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。 コレクションが作成されました。
{
"_collectionName" : <collectionName>,
"_id" : <id>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。 ドキュメントが作成されました。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveClient::CollectionCreate BtrieveCollection::DocumentCreate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ POST() [2/2]

static const char* BRestful::POST ( const char *  collectionName,
const char *  json,
const char *  blob,
int  blobLength 
)
static

コレクションまたはドキュメントを作成します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]jsonjson。json が NULL である場合は、コレクションが作成されます。
[in]blobblob。json が NULL である場合、blob および blobLength は無視されます。
[in]blobLengthblob の長さ。
説明
コレクションの作成によって既存のコレクションは上書きされません。既存のコレクションは最初に削除しておく必要があります。 BRestful::DELETE を参照してください。
ドキュメントを作成するには、まず、含まれるコレクションが存在している必要があります。
戻り値
{
"_collectionName" : <collectionName>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。 コレクションが作成されました。
{
"_collectionName" : <collectionName>,
"_id" : <id>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。 ドキュメントが作成されました。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveClient::CollectionCreate BtrieveCollection::DocumentCreate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ PUT() [1/2]

static const char* BRestful::PUT ( const char *  collectionName,
int  id,
const char *  json 
)
static

ドキュメントを更新します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]idID。
[in]jsonjson。
戻り値
{
"_collectionName" : <collectionName>,
"_id" : <id>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveCollection::DocumentUpdate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ PUT() [2/2]

static const char* BRestful::PUT ( const char *  collectionName,
int  id,
const char *  json,
const char *  blob,
int  blobLength 
)
static

ドキュメントを更新します。

覚え書き
このメソッドはスレッド セーフではありません。返された文字列は、次の呼び出しで上書きされます。
引数
[in]collectionNameコレクション名。
[in]idID。
[in]jsonjson。
[in]blobblob。
[in]blobLengthblob の長さ。
戻り値
{
"_collectionName" : <collectionName>,
"_id" : <id>,
"_statusCode" : 0,
"_statusString" : "No error"
}
成功。
{
"_statusCode" : <statusCode>,
"_statusString" : <statusString>
}
エラーが発生しました。
参照
BtrieveCollection::DocumentUpdate Btrieve::StatusCode Btrieve::StatusCodeToString