高度なクエリの実行¶
OData では、高度なリクエストを作成できるように以下のクエリオプションを定義しています。
$filter$select$orderby$expand
選択: $filter¶
$filter システムクエリオプションを使用した URI は、 $filter 述語式を満たすコレクションのエンティティの一部を特定します。
式ではプロパティとリテラルを参照できます。リテラルには、文字列 (一重引用符で囲んで記述)、 null リテラル、数値、または boolean 値を使用できます。
このサービスでは、以下の演算と関数をサポートしています。
演算子¶
演算子 |
説明 |
例 |
|---|---|---|
eq |
等しい |
|
ne |
等しくない |
|
gt |
より大きい |
|
ge |
以上 |
|
lt |
より小さい |
|
le |
以下 |
|
and |
論理積 |
|
or |
論理和 |
|
not |
論理否定 |
|
add |
加算 |
|
sub |
減算 |
|
mul |
乗算 |
|
div |
除算 |
|
mod |
剰余 |
|
() |
優先順位グループ |
|
文字列関数¶
文字列演算では、以下の各関数を使用できます。
contains(string p0, string p1):p0で指定したプロパティ名の値に文字列p1が使用されていればtrue、使用されていなければfalseが返されます。startswith(string p0, string p1):p0で指定したプロパティ名の値が文字列p1で始まる場合はtrue、それ以外の場合はfalseが返されます。endswith(string p0, string p1):p0で指定したプロパティ名の値が文字列p1で終わる場合はtrue、それ以外の場合はfalseが返されます。indexof(string p0, string p1):p0で指定したプロパティ名の値の中で文字列p1が占める位置が返されます。length(p0):p0で指定したプロパティ名の値の長さが返されます。substring(string p0, int pos):p0で指定したプロパティ名の値の部分文字列が新しい文字列として返されます。この部分文字列は、posで指定した位置にある文字から文字列末尾までの文字列です。substring(string p0, int pos, int length):p0で指定したプロパティ名の値の部分文字列が新しい文字列として返されます。この部分文字列は、posで指定した位置にある文字からpos+lengthの位置にある文字までの文字列です。tolower(string p0):p0で指定したプロパティ名の値を小文字に変換した文字列が返されます。toupper(string p0):p0で指定したプロパティ名の値を大文字に変換した文字列が返されます。trim(string p0):p0で指定したプロパティ名の値から先頭と末尾の空白を削除した文字列が返されます。concat(string p0, string p1): 文字列p0と文字列p1を連結した新しい文字列が返されます。
上記の関数の概要と使用例を以下の表に示します。
関数 |
例 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
数学関数¶
数学関数として round 、 floor 、 ceiling の 3 つがあります。それぞれにパラメータとして Double 型または Decimal 型の値を指定でき、そのパラメータと同じ型の戻り値が返されます。
関数 |
例 |
|---|---|
round |
|
floor |
|
ceiling |
|
日付関数¶
関数 |
例 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
投影: $select¶
$select システムクエリオプションを指定すると、明示的に要求したプロパティのみが返されます。 $select 式には、プロパティのカンマ区切りリストまたはアスタリスク演算子 (*) を指定できます。アスタリスク演算子を使用すると、すべてのプロパティが取得されます。
例:
/denodo-odata.svc/movies/actor?$select=actor_id,first_name,last_name
応答:
{
"@odata.context":"/denodo-odata.svc/movies/$metadata#actor(actor_id,first_name,last_name)",
"value": [
{
"actor_id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS"
},
...
]
}
例:
/denodo-odata.svc/movies/actor?$select=*
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#actor(*)",
"value": [
{
"actor_id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS",
"last_update": "2006-02-15T11:34:33Z"
},
...
]
}
注釈
$select 式では複合プロパティを指定できます。
denodo-odata.svc/admin/struct_table_film?$select=film_data/title
応答:
{
"@odata.context":"/denodo-odata.svc/admin/$metadata
#struct_table_film(film_data/title)",
"value": [
{
"@odata.id": "/denodo-odata.svc/admin/struct_table_film(1)",
"film_data": {
"title": "ACADEMY DINOSAUR"
}
...
}
...
]
}
結果の並べ替え: $orderby¶
$orderby クエリパラメータは、アイテムが返される順序を指定します。
/denodo-odata.svc/<database name>/collectionName?$orderby=attribute [asc|desc]
コレクションを並べ替えるには、リソースパスでエントリのコレクションを指定する必要があります。指定しないと、このオプションを使用できません。
キーワードの asc と desc は、並べ替えの方向 (それぞれ昇順と降順) を指定します。 asc も desc も指定していない場合、アイテムは昇順で返されます。昇順の場合、Null 値は Null 以外の値よりも前に置かれ、降順の場合はその逆の順序になります。
複数の属性を基準として並べ替えることもできます。
/denodo-odata.svc/<database name>/collectionName?$orderby=attribute1 [asc|desc],attribute2 [asc|desc]
例:
/denodo-odata.svc/movies/address?$orderby=zip,client_identifier desc
パラメータの別名¶
パラメータの別名は、 @ 記号を接頭辞とする識別子です。クエリの式に使用することで、同じリテラルを何回も記述する必要がなくなる、長いリテラルを読みやすい位置に記述できるなどの利点があります。
例:
/denodo-odata.svc/movies/film?$filter=contains(title,@p1) and not contains(description,@p1)&@p1='ACADEMY DINOSAUR'
結果の最大数の指定: $top¶
$top オプションを使用すると、コレクションの先頭から n 件のエントリを選択できます。 n は負数ではない整数です。
/denodo-odata.svc/<database name>/collectionName?$top=n
例:
/denodo-odata.svc/movies/actor?$top=1
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#actor",
"value": [
{
"actor_id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS",
"last_update": "2006-02-15T11:34:33Z"
}
]
}
オフセットの指定: $skip¶
$skip オプションを使用すると、コレクションの先頭から n 件のエントリが応答に表示されません。 n は負数ではない整数です。
denodo-odata.svc/<database name>/collectionName?$skip=n
例:
/denodo-odata.svc/movies/actor?$skip=199
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#actor",
"value": [
{
"actor_id": 200,
"first_name": "THORA",
"last_name": "TEMPLE",
"last_update": "2006-02-15T11:34:33Z"
}
]
}
結果の総数の要求: $count¶
$count システムクエリオプションを指定すると、応答で返されるアイテムの数が結果と共に返されます。
以前の構文 $inlinecount=allpages が、OData 4 では短縮されて $count=true になっています。
$count システムクエリオプションでは、 $top 、 $skip 、および $expand の各クエリオプションが無視され、指定した $filter に一致する結果のみで構成されたページのすべてにわたり、そこに存在する結果の総数が返されます。
例:
/denodo-odata.svc/movies/actor?$count=true
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#actor",
"@odata.count": 200,
"value": [
{
"actor_id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS",
"last_update": "2006-02-15T11:34:33Z"
},
...
]
}
例:
/denodo-odata.svc/movies/actor?$count=true&$filter=actor_id eq 1
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#actor",
"@odata.count": 1,
"value": [
{
"actor_id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS",
"last_update": "2006-02-15T11:34:33Z"
}
]
}
例:
/denodo-odata.svc/movies/actor?$count=false
応答:
$count オプションを指定していないリクエストと同じ actor データ:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#actor",
"value": [
{
"actor_id": 1,
"first_name": "PENELOPE",
"last_name": "GUINESS",
"last_update": "2006-02-15T11:34:33Z"
},
...
]
}
ラムダ演算子: any¶
OData では、 ラムダ演算子 というコレクションで Boolean 式を評価する演算子を定義しています。ラムダ演算子の引数は、後ろにコロン (:) が付いたラムダ変数名と、ナビゲーションパスで識別される関連エンティティのプロパティを指すラムダ変数名を使用する Boolean 式です。
any 演算子は、Boolean 式をコレクションの各メンバーに適用し、その式がコレクションのいずれかのメンバーに当てはまる場合に true を返し、それ以外の場合は false を返します。
/denodo-odata.svc/<DBNAME>/collectionName?$filter=relatedEntity/any(f:f/relatedEntityField <OPERATION> <VALUE>)
/denodo-odata.svc/<DBNAME>/collectionName?$filter=relatedEntity/any(f:f/relatedEntityField <OPERATION> <VALUE>)
例:
/denodo-odata.svc/country?$filter=city/any(f:f/city_id eq 2)
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#country",
"value": [
{
"country_id": 82,
"country": "Saudi Arabia",
"last_update": "2006-02-15T02:44:00Z"
}
]
}
例:
/denodo-odata.svc/country?$filter=country_id eq 87&$expand=city($filter=address_sakila/any(f:f/address_id eq 56))
応答:
{
"@odata.context": "/denodo-odata.svc/movies/$metadata#country(city())",
"value": [
{
"country_id": 87,
"country": "Spain",
"last_update": "2006-02-15T02:44:00Z",
"city": [
{
"city_id": 1,
"city": "A Coruna (La Coruna)",
"country_id": 87,
"last_update": "2006-02-15T02:45:25Z"
}
]
}
]
}
なお、Denodo OData サービスでは、 All 演算子はサポートされていません。