BRestful クラス。 [詳解]

#include <btrieveCpp.h>

静的公開メンバ関数
static const char *	DELETE (const char *collectionName, int id=-1, int entityTag=-1)
	コレクションまたはドキュメントを削除します。

static const char *	GET (const char collectionName, const char query=NULL)
	ドキュメント ID を取得します。

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 *	POST (const char collectionName, const char json, const char *blob, int blobLength)
	コレクションまたはドキュメントを作成します。

static const char *	POST (const char collectionName, const char json=NULL)
	コレクションまたはドキュメントを作成します。

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)
	ドキュメントを更新します。

static const char *	PUT (const char collectionName, int id, int entityTag, const char json)
	ドキュメントを更新します。

static const char *	PUT (const char collectionName, int id, int entityTag, 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	いいえ	文字列	コレクション名
_entityTag	いいえ	数値	エンティティタグ
_ids	いいえ	数値の配列	ドキュメント ID の配列
_statusCode	いいえ	数値	ステータスコード
_statusString	いいえ	文字列	ステータス文字列

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

参照: BtrieveCollection

関数詳解

◆ DELETE()

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。id が指定されていないか、または -1 である場合は、コレクションが削除されます。
[in]	entityTag	エンティティタグ。エンティティタグは、ドキュメントのエンティティタグと等しいか、または -1 である必要があります。

スニペット: Python brestful.py
response = json.loads(btrievePython.BRestful.DELETE(collectionName))

assert(response["_statusCode"] == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), response["_statusString"]

戻り値: {

"_collectionName" : <collectionName>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。コレクションが削除されました。; {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_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,
		const char *	query = NULL )

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	query	クエリ。

スニペット: Python brestful.py
response = json.loads(btrievePython.BRestful.GET(collectionName, query))

assert(response["_statusCode"] == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), response["_statusString"]

戻り値: {

"_collectionName" : <collectionName>,

"_ids" : [ <id> ... ],

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveCollection::Query Btrieve::StatusCode Btrieve::StatusCodeToString

◆ GET() [2/3]

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。

スニペット: Python brestful.py
response = json.loads(btrievePython.BRestful.GET(collectionName, documentId))

assert(response["_statusCode"] == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), response["_statusString"]

戻り値: {

<documentJson>,

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_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,
		int	id,
		char *	blob,
		int	blobSize,
		int	documentBlobOffset = 0,
		int	documentBlobLength = 0 )

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。
[out]	blob	blob。
[in]	blobSize	blob のサイズ。
[in]	documentBlobOffset	ドキュメントの blob のオフセット。
[in]	documentBlobLength	ドキュメントの blob の長さ。

戻り値: {

<documentJson>,

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveCollection::DocumentRetrieve Btrieve::StatusCode Btrieve::StatusCodeToString

◆ POST() [1/2]

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	json	json。json が NULL である場合は、コレクションが作成されます。
[in]	blob	blob。json が NULL である場合、blob および blobLength は無視されます。
[in]	blobLength	blob の長さ。

説明: コレクションの作成によって既存のコレクションは上書きされません。既存のコレクションは最初に削除しておく必要があります。 BRestful::DELETE を参照してください。

: ドキュメントを作成するには、まず、含まれるコレクションが存在している必要があります。

戻り値: {

"_collectionName" : <collectionName>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。コレクションが作成されました。; {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_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 = NULL )

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	json	json。json が指定されていないか、または NULL である場合は、コレクションが作成されます。

説明: コレクションの作成によって既存のコレクションは上書きされません。既存のコレクションは最初に削除しておく必要があります。 BRestful::DELETE を参照してください。

: ドキュメントを作成するには、まず、含まれるコレクションが存在している必要があります。

スニペット: Python brestful.py
response = json.loads(btrievePython.BRestful.POST(collectionName))

assert(response["_statusCode"] == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), response["_statusString"]

スニペット: Python brestful.py
response = json.loads(btrievePython.BRestful.POST(collectionName, documentJson))

assert(response["_statusCode"] == btrievePython.Btrieve.STATUS_CODE_NO_ERROR), response["_statusString"]

戻り値: {

"_collectionName" : <collectionName>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。コレクションが作成されました。; {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_id" : <id>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。ドキュメントが作成されました。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveClient::CollectionCreate BtrieveCollection::DocumentCreate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ PUT() [1/4]

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。
[in]	json	json。

戻り値: {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_id" : <id>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveCollection::DocumentUpdate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ PUT() [2/4]

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。
[in]	json	json。
[in]	blob	blob。
[in]	blobLength	blob の長さ。

戻り値: {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_id" : <id>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveCollection::DocumentUpdate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ PUT() [3/4]

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。
[in]	entityTag	エンティティタグ。エンティティタグは、ドキュメントのエンティティタグと等しいか、または -1 である必要があります。
[in]	json	json。

戻り値: {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_id" : <id>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveCollection::DocumentUpdate Btrieve::StatusCode Btrieve::StatusCodeToString

◆ PUT() [4/4]

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

static

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

覚え書き: このメソッドはスレッドセーフではありません。返された文字列は、次の呼び出しで上書きされます。

引数

[in]	collectionName	コレクション名。
[in]	id	ID。
[in]	entityTag	エンティティタグ。エンティティタグは、ドキュメントのエンティティタグと等しいか、または -1 である必要があります。
[in]	json	json。
[in]	blob	blob。
[in]	blobLength	blob の長さ。

戻り値: {

"_collectionName" : <collectionName>,

"_entityTag": <entityTag>,

"_id" : <id>,

"_statusCode" : 0,

"_statusString" : "No error"

}

成功。; {

"_statusCode" : <statusCode>,

"_statusString" : <statusString>

}

エラーが発生しました。

参照: BtrieveCollection::DocumentUpdate Btrieve::StatusCode Btrieve::StatusCodeToString

静的公開メンバ関数

詳解

関数詳解

◆ DELETE()

◆ GET() [1/3]

◆ GET() [2/3]

◆ GET() [3/3]

◆ POST() [1/2]

◆ POST() [2/2]

◆ PUT() [1/4]

◆ PUT() [2/4]

◆ PUT() [3/4]

◆ PUT() [4/4]