DataClass
データクラス はデータベーステーブルへのオブジェクトインターフェースを提供します。 4Dアプリケーション内のデータクラスはすべて、ds データストア のプロパティとして利用可能です。
概要
.attributeName
履歴
| リリース | 内容 |
|---|---|
| 19 R3 | .exposed 属性を追加 |
| 17 | 追加 |
.attributeName : object
説明
データクラスの属性は、 プロパティとして直接利用可能なオブジェクトです 。
返されるオブジェクトのプロパティを読み取ることによって、データクラス属性に関する情報が取得できます。
データクラス属性オブジェクトを編集することは可能ですが、元となるデータベースストラクチャーは変更されません。
返されるオブジェクト
返される属性オブジェクトには以下のプロパティが格納されています:
| プロパティ | 型 | 説明 |
|---|---|---|
| autoFilled | Boolean | 属性値が 4D によって自動生成される場合に true です。 このプロパティは次の 4Dフィールドプロパティに対応しています: 数値型フィールドの "自動インクリメント" および UUID (文字型)フィールドの "自動UUID"。 .kind が "relatedEntity" または "relatedEntities" の場合には、このプロパティは返されません。 |
| exposed | Boolean | 属性が REST で公開されている場合に trueです |
| fieldNumber | integer | 属性の内部的な 4Dフィールド番号。 .kind が "relatedEntity" または "relatedEntities" の場合には、このプロパティは返されません。 |
| fieldType | Integer | 属性の 4Dデータベースフィールドタイプ。 これは属性の種類 (kind) によります。 とりうる値: .kind = "storage" の場合は、対応する 4Dフィールドタイプ (Value type 参照).kind = "relatedEntity" の場合: 38 (is object).kind = "relatedEntities" の場合: 42 (is collection).kind = "calculated" または "alias" の場合: 結果の値 (フィールドタイプ、relatedEntity または relatedEntities) に応じて、上に同じ |
| indexed | Boolean | 属性に対して B-tree もしくは クラスターB-Tree インデックスが設定されている場合に true です。 .kind が "relatedEntity" または "relatedEntities" の場合には、このプロパティは返されません。 |
| inverseName | Text | リレーション先の属性名。 .kind = "relatedEntity" または "relatedEntities" の場合にのみ返されます。 |
| keywordIndexed | Boolean | 属性にキーワードインデックスが存在すれば true です。 .kind が "relatedEntity" または "relatedEntities" の場合には、このプロパティは返されません。 |
| kind | Text | 属性の種類。 とりうる値:get 関数 によって定義されます。 |
| 必須 | Boolean | 属性において Null値の入力が拒否されている場合に true です。 .kind が "relatedEntity" または "relatedEntities" の場合には、このプロパティは返されません。 注記: このプロパティは、4Dデータベースレベルの "Null値の入力を拒否" フィールドプロパティと対応しています。 フィールドのデータ入力制御オプションである既存の "必須入力" プロパティとは無関係です。 |
| name | Text | 属性名 (文字列) |
| path | Text | リレーションに基づく エイリアス属性 のパス。 |
| readOnly | Boolean | 読み取り専用属性の場合に trueです。 たとえば、set 関数 を持たない計算属性は読み取り専用です。 |
| relatedDataClass | Text | 属性にリレートされているデータクラスの名称。 .kind = "relatedEntity" または "relatedEntities" の場合にのみ返されます。 |
| type | Text | 属性の概念的な値タイプ。汎用的なプログラミングに有用です。 これは属性の種類 (kind) によります。 とりうる値: .kind = "storage" の場合: "blob", "bool", "date", "image", "number", "object", または "string"。 数値型の場合 "number" が返されます (時間を含む)。UUID、文字およびテキスト型フィールドの場合 "string" が返されます。"blob" 属性は BLOB オブジェクト です。.kind = "relatedEntity" の場合: リレートされたデータクラス名.kind = "relatedEntities" の場合: リレートされたデータクラス名 + "Selection" 接尾辞.kind = "calculated" または "alias" の場合: 結果の値に応じて、上に同じ |
| unique | Boolean | 属性値が重複不可の場合に true です。 .kind が "relatedEntity" または "relatedEntities" の場合には、このプロパティは返されません。 |
汎用的なプログラミングにおいては、プロパティが返されない場合でも有効な値を取得するため、Bool(attributeName.property)、Num(attributeName.property)、または String(attributeName.property) をプロパティの型に応じて使用することが推奨されます。
例題 1
$salary:=ds.Employee.salary // Employeeデータクラスの salary属性を返します
$compCity:=ds.Company["city"] // Companyデータクラスの city属性を返します
例題 2
以下のストラクチャーを前提とします:
var $firstnameAtt;$employerAtt;$employeesAtt : Object
$firstnameAtt:=ds.Employee.firstname
//{name:firstname,kind:storage,fieldType:0,type:string,fieldNumber:2,indexed:true,
//keyWordIndexed:false,autoFilled:false,mandatory:false,unique:false}
$employerAtt:=ds.Employee.employer
//{name:employer,kind:relatedEntity,relatedDataClass:Company,
//fieldType:38,type:Company,inverseName:employees}
//38=Is object
$employeesAtt:=ds.Company.employees
//{name:employees,kind:relatedEntities,relatedDataClass:Employee,
//fieldType:42,type:EmployeeSelection,inverseName:employer}
//42=Is collection
例題 3
以下のテーブルプロパティを前提とします:
var $sequenceNumberAtt : Object
$sequenceNumberAtt=ds.Employee.sequenceNumber
//{name:sequenceNumber,kind:storage,fieldType:0,type:string,fieldNumber:13,
//indexed:true,keyWordIndexed:false,autoFilled:true,mandatory:false,unique:true}
.all()
履歴
| リリース | 内容 |
|---|---|
| 17 R5 | settings パラメーターをサポート |
| 17 | 追加 |
.all ( { settings : Object } ) : 4D.EntitySelection
| 引数 | 型 | 説明 | |
|---|---|---|---|
| settings | Object | -> | ビルドオプション: context |
| 戻り値 | 4D.EntitySelection | <- | データクラスの全エンティティの参照 |
|
説明
.all() 関数は データストアをクエリして、データクラスの全エンティティをエンティティセレクションとして返します。
エンティティはデフォルトの順番で返され、通常は作成順になっています。 ただし、エンティティ削除後に新規追加した場合には、デフォルトの順番は作成順を反映しない点に留意が必要です。
エンティティが見つからない場合、空のエンティティセレクションが返されます。
この関数には、レイジーローディングが適用されます。
settings
任意の settings パラメーターには、追加オプションを格納したオブジェクトを渡すことができます。 以下のプロパティがサポートされています:
| プロパティ | 型 | 説明 |
|---|---|---|
| context | Text | エンティティセレクションに適用されている最適化コンテキストのラベル。 エンティティセレクションを扱うコードはこのコンテキストを使うことで最適化の恩恵を受けます。 この機能は ORDA のクライアント/サーバー処理を想定して設計されています。 |
データクラス内の総エンティティ数を知るには、
ds.myClass.all().length式よりも最適化されたgetCount()関数を使用することが推奨されます。
例題
var $allEmp : cs.EmployeeSelection
$allEmp:=ds.Employee.all()
.clearRemoteCache()
履歴
| リリース | 内容 |
|---|---|
| 19 R5 | 追加 |
.clearRemoteCache()
| 引数 | 型 | | 説明 | | -- | - |::| -------------------------------------------- | | | | | このコマンドは引数を必要としません|
|
説明
.clearRemoteCache() 関数は、 データクラスの ORDAキャッシュを空にします。
この関数は
timeoutおよびmaxEntriesの値をリセットしません。
例題
var $ds : 4D.DataStoreImplementation
var $persons : cs.PersonsSelection
var $p : cs.PersonsEntity
var $cache : Object
var $info : Collection
var $text : Text
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$persons:=$ds.Persons.all()
$text:=""
For each ($p; $persons)
$text:=$p.firstname+" lives in "+$p.address.city+" / "
End for each
$cache:=$ds.Persons.getRemoteCache()
$ds.Persons.clearRemoteCache()
// Persons データクラスのキャッシュ = {timeout:30;maxEntries:30000;stamp:255;entries:[]}
.fromCollection()
履歴
| リリース | 内容 |
|---|---|
| 17 R5 | settings パラメーターをサポート |
| 17 | 追加 |
.fromCollection( objectCol : Collection { ; settings : Object } ) : 4D.EntitySelection
| 引数 | 型 | 説明 | |
|---|---|---|---|
| objectCol | Collection | -> | エンティティにマップするオブジェクトのコレクション |
| settings | Object | -> | ビルドオプション: context |
| 戻り値 | 4D.EntitySelection | <- | コレクションから作成したエンティティセレクション |
|
説明
.fromCollection() 関数は、 objectCol 引数のオブジェクトのコレクションに基づいてデータクラスのエンティティを更新あるいは作成し、対応するエンティティセレクションを返します。
objectCol パラメーターには、データクラスの既存エンティティを更新、または新規エンティティを作成するためのオブジェクトのコレクションを渡します。 プロパティ名は、データクラスの属性名と同一である必要があります。 プロパティ名がデータクラスに存在しない場合、それは無視されます。 コレクション内で属性値が定義されていない場合、その値は null になります。
コレクションのオブジェクト要素とエンティティのマッピングは、属性名 と 型の合致 をもって行われます。 オブジェクトプロパティがエンティティ属性と同じ名前であっても、型が合致しない場合には、エンティティの属性は空のままです。
作成モードと更新モード
objectCol 引数の各オブジェクトついて:
- オブジェクトがブール型の "__NEW" プロパティを含み、それが false に設定されている場合(あるいは "__NEW" プロパティが含まれていない場合)、オブジェクトの対応する値でエンティティが更新あるいは作成されます。 プライマリーキーに関するチェックはおこなわれません:
- プライマリーキーが指定されていて実在する場合、エンティティは更新されます。 この場合、プライマリーキーはそのまま、あるいは "__KEY" プロパティを (プライマリーキー値とともに) 使って指定することができます。
- そのまま指定したプライマリーキーが実在しない場合、エンティティは作成されます。
- プライマリーキーを指定していない場合、エンティティは作成され、標準のデータベースのルールに基づいてプライマリーキー値が割り当てられます。
- オブジェクトがブール型の "__NEW" プロパティを含み、それが true に設定されている場合、オブジェクトの対応する値でエンティティが作成されます。 プライマリーキーに関するチェックがおこなわれます:
- そのまま指定したプライマリーキーが実在する場合、エラーが返されます。
- そのまま指定したプライマリーキーが実在しない場合、エンティティは作成されます。
- プライマリーキーを指定していない場合、エンティティは作成され、標準のデータベースのルールに基づいてプライマリーキー値が割り当てられます。
値を持つ "__KEY" プロパティは、"__NEW" プロパティが false に設定 (あるいは省略) されていて、かつ対応するエンティティが存在する場合のみ、考慮されます。 それ以外の場合には、"__KEY" プロパティ値は無視されるため、プライマリーキーの値はそのまま渡さなければなりません。
リレートエンティティ
objectCol 引数のオブジェクトは、一つ以上のリレートエンティティに対応するオブジェクトをネストすることができます。これはエンティティ間のリンクを作成・更新するのに有用です。
リレートエンティティに相当するネストされたオブジェクトは、リレートエンティティのプライマリーキー値を格納した "__KEY" プロパティあるいはプライマリーキー属性を格納している必要があります。 ”__KEY” プロパティを使用すると、プライマリーキー属性名に依存する必要がありません。
この機構によって、リレートエンティティの中身を作成・更新することはできません。
記号
"__STAMP" プロパティが指定された場合、データストアのスタンプとのチェックがおこなわれ、エラーが返されることがあります ("与えられたスタンプはテーブルXXX のレコード# XXのカレントのものと合致しません")。 詳細については エンティティロッキング を参照ください。
settings
任意の settings パラメーターには、追加オプションを格納したオブジェクトを渡すことができます。 以下のプロパティがサポートされています:
| プロパティ | 型 | 説明 |
|---|---|---|
| context | Text | エンティティセレクションに適用されている最適化コンテキストのラベル。 エンティティセレクションを扱うコードはこのコンテキストを使うことで最適化の恩恵を受けます。 この機能は ORDA のクライアント/サーバー処理を想定して設計されています。 |
例題 1
既存のエンティティを更新します。 __NEW プロパティはなく、従業員のプライマリーキーは属性に実在の値を指定して渡します:
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.ID:=668 // Employeeテーブルの実在する主キー
$emp.firstName:="Arthur"
$emp.lastName:="Martin"
$emp.employer:=New object("ID";121) // リレートデータクラス Company の実在する主キー
// リレートデータクラス Company に実在する別の主キーを指定すれば、会社を変更することができます
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
例題 2
既存のエンティティを更新します。 __NEW プロパティはなく、従業員のプライマリーキーは __KEY プロパティに実在の値を指定して渡します:
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.__KEY:=1720 // Employeeテーブルの実在する主キー
$emp.firstName:="John"
$emp.lastName:="Boorman"
$emp.employer:=New object("ID";121) // リレートデータクラス Company の実在する主キー
// リレートデータクラス Company に実在する別の主キーを指定すれば、会社を変更することができます
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
例題 3
単純に、コレクションから新しいエンティティを作成します:
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.firstName:="Victor"
$emp.lastName:="Hugo"
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
例題 4
新規エンティティを作成します。 __NEW プロパティは true で、従業員のプライマリーキーは指定しません:
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.firstName:="Mary"
$emp.lastName:="Smith"
$emp.employer:=New object("__KEY";121) // リレートデータクラス Company の実在する主キー
$emp.__NEW:=True
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
例題 5
新規エンティティを作成します。 __NEW プロパティはなく、従業員のプライマリーキー属性を指定しますが、その値は実在しません:
var $empsCollection : Collection
var $emp : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.ID:=10000 // 実在しない主キー
$emp.firstName:="Françoise"
$emp.lastName:="Sagan"
$empsCollection.push($emp)
$employees:=ds.Employee.fromCollection($empsCollection)
例題 6
2つのエンティティが同じプライマリーキーを持つ場合、最初のエンティティは作成・保存されますが、2つめのエンティティの処理は失敗します:
var $empsCollection : Collection
var $emp; $emp2 : Object
var $employees : cs.EmployeeSelection
$empsCollection:=New collection
$emp:=New object
$emp.ID:=10001 // 実在しない主キー
$emp.firstName:="Simone"
$emp.lastName:="Martin"
$emp.__NEW:=True
$empsCollection.push($emp)
$emp2:=New object
$emp2.ID:=10001 // 上と同じ主キー
$emp2.firstName:="Marc"
$emp2.lastName:="Smith"
$emp2.__NEW:=True
$empsCollection.push($emp2)
$employees:=ds.Employee.fromCollection($empsCollection)
// 最初のエンティティは作成されます
// 2つめのエンティティは重複キーエラーになります
参照
.get()
履歴
| リリース | 内容 |
|---|---|
| 17 | 追加 |
.get( primaryKey : Integer { ; settings : Object } ) : 4D.Entity
.get( primaryKey : Text { ; settings : Object } ) : 4D.Entity
| 引数 | 型 | 説明 | |
|---|---|---|---|
| primaryKey | Integer または Text | -> | 取得するエンティティのプライマリーキー値 |
| settings | Object | -> | ビルドオプション: context |
| 戻り値 | 4D.Entity | <- | 指定したプライマリーキーに合致するエンティティ |
|
説明
.get() 関数は データクラスをクエリして、primaryKey に渡したプライマリーキーに合致するエンティティを返します。
primaryKey には、取得したいエンティティのプライマリーキーの値を渡します。 値の型は、データストアで設定されたプライマリーキーの型 (倍長整数あるいはテキスト) と合致している必要があります。 .getKey() 関数に dk key as string 引数を渡すと、プライマリーキーの値が常にテキスト型で返されるように指定することができます。
primaryKey 引数のプライマリーキーを持つエンティティが見つからない場合、Null エンティティが返されます。
この関数にはレイジーローディングが適用され、リレートデータは必要な時にのみディスクから読み込まれます。
settings
任意の settings パラメーターには、追加オプションを格納したオブジェクトを渡すことができます。 以下のプロパティがサポートされています:
| プロパティ | 型 | 説明 |
|---|---|---|
| context | Text | エンティティに適用されている自動の最適化コンテキストのラベル。 エンティティを読み込む以降のコードは、このコンテキストを使うことで最適化の恩恵を受けます。 この機能は ORDA のクライアント/サーバー処理を想定して設計されています。 |
例題 1
var $entity : cs.EmployeeEntity
var $entity2 : cs.InvoiceEntity
$entity:=ds.Employee.get(167) // プライマリーキーの値が 167のエンティティを返します
$entity2:=ds.Invoice.get("DGGX20030") // プライマリーキーの値が "DGGX20030" のエンティティを返します
例題 2
context プロパティの使用について紹介します:
var $e1; $e2; $e3; $e4 : cs.EmployeeEntity
var $settings; $settings2 : Object
$settings:=New object("context";"detail")
$settings2:=New object("context";"summary")
$e1:=ds.Employee.get(1;$settings)
completeAllData($e1) // completeAllData メソッドにおいて最適化がトリガーされ、"detail" コンテキストが割り当てられます
$e2:=ds.Employee.get(2;$settings)
completeAllData($e2) // completeAllData メソッドには、"detail" コンテキストに付随する最適化が適用されます
$e3:=ds.Employee.get(3;$settings2)
completeSummary($e3) // completeSummary メソッドにおいて最適化がトリガーされ、"summary" コンテキストが割り当てられます
$e4:=ds.Employee.get(4;$settings2)
completeSummary($e4) // completeSummary メソッドには、"summary" コンテキストに付随する最適化が適用されます
.getCount()
履歴
| リリース | 内容 |
|---|---|
| 19 R5 | 追加 |
.getCount() : Integer
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | Integer | <- | データクラスに含まれる全エンティティ数 |
|
説明
.getCount() 関数は、 データクラスに含まれる総エンティティ数を返します。
トランザクション内でこの関数を使用した場合、トランザクション中に作成されたエンティティは考慮されます。
例題
var $ds : 4D.DataStoreImplementation
var $number : Integer
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$number:=$ds.Persons.getCount()
.getDataStore()
履歴
| リリース | 内容 |
|---|---|
| 17 R5 | 追加 |
.getDataStore() : cs.DataStore
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | cs.DataStore | <- | データクラスが属しているデータストア |
|
説明
.getDataStore() 関数は、 指定したデータクラスが属しているデータストアを返します。
返されるデータストアは次のいずれかです:
dsコマンドによって返されるメインデータストアOpen datastoreコマンドを使用して開かれたリモートデータストア
例題
SearchDuplicate プロジェクトメソッドは、任意のデータクラス内の重複した値を検索します。
var $pet : cs.CatsEntity
$pet:=ds.Cats.all().first() // エンティティを取得します
SearchDuplicate($pet;"Dogs")
// SearchDuplicate メソッド
// SearchDuplicate(entity_to_search;dataclass_name)
#DECLARE ($pet : Object ; $dataClassName : Text)
var $dataStore; $duplicates : Object
$dataStore:=$pet.getDataClass().getDataStore()
$duplicates:=$dataStore[$dataClassName].query("name=:1";$pet.name)
.getInfo()
履歴
| リリース | 内容 |
|---|---|
| 19 R3 | exposed プロパティを追加 |
| 17 R5 | 追加 |
.getInfo() : Object
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | Object | <- | データクラスの情報 |
|
説明
.getInfo() 関数は、 データクラスの情報を提供するオブジェクトを返します。 このメソッドは汎用的なコードを書くのに有用です。
返されるオブジェクト
| プロパティ | 型 | 説明 |
|---|---|---|
| exposed | Boolean | データクラスが REST に公開されていれば true |
| name | Text | データクラスの名称 |
| primaryKey | Text | データクラスのプライマリーキー属性の名称 |
| tableNumber | Integer | 内部的な 4Dテーブル番号 |
例題 1
#DECLARE ($entity : Object)
var $status : Object
computeEmployeeNumber($entity) // エンティティに対する何らかの操作
$status:=$entity.save()
if($status.success)
ALERT("テーブル "+$entity.getDataClass().getInfo().name+" のレコードが更新されました。")
End if
例題 2
var $settings : Object
var $es : cs.ClientsSelection
$settings:=New object
$settings.parameters:=New object("receivedIds";getIds())
$settings.attributes:=New object("pk";ds.Clients.getInfo().primaryKey)
$es:=ds.Clients.query(":pk in :receivedIds";$settings)
例題 3
var $pk : Text
var $dataClassAttribute : Object
$pk:=ds.Employee.getInfo().primaryKey
$dataClassAttribute:=ds.Employee[$pk] // 必要に応じてプライマリーキー属性へのアクセスが可能です
.getRemoteCache()
履歴
| リリース | 内容 |
|---|---|
| 19 R5 | 追加 |
.getRemoteCache() : Object
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | Object | <- | データクラスの ORDAキャッシュの内容を記述したオブジェクト。 |
|
上級者向け: この機能は、特定の構成のため、ORDAのデフォルト機能をカスタマイズする必要がある開発者向けです。 ほとんどの場合、使用する必要はないでしょう。
説明
.getRemoteCache() 関数は、 データクラスの ORDAキャッシュの内容を記述したオブジェクトを返します。
4D のシングルユーザーアプリケーションからこの関数を呼び出した場合、Null が返されます。
戻り値のオブジェクトには、以下のプロパティが格納されています:
| プロパティ | 型 | 説明 |
|---|---|---|
| maxEntries | Integer | エントリーコレクションの最大数 |
| stamp | Integer | キャッシュのスタンプ |
| timeout | Integer | キャッシュの新しいエントリーが期限切れとなるまでの残り時間。 |
| entries | Collection | キャッシュ内の各エンティティにつき、1つのエントリーオブジェクトを格納します。 |
エントリーコレクション内の各エントリーオブジェクトは、以下のプロパティを持ちます:
| プロパティ | 型 | 説明 |
|---|---|---|
| data | Object | エントリーのデータを格納するオブジェクト |
| expired | Boolean | エントリーが期限切れの場合に true |
| key | Text | エンティティのプライマリーキー。 |
各エントリーの data オブジェクトは、以下のプロパティを持ちます:
| プロパティ | 型 | 説明 |
|---|---|---|
| __KEY | Text | エンティティのプライマリーキー |
| __STAMP | Integer | データベース内のエンティティのタイムスタンプ |
| __TIMESTAMP | Text | データベース内のエンティティのスタンプ (形式: YYYY-MM-DDTHH:MM:SS:ms:Z) |
| dataClassAttributeName | Variant | データクラス属性に対応するデータがキャッシュに存在する場合、それはデータベースと同じ型のプロパティに返されます。 |
リレートエンティティに関するデータは、data オブジェクトのキャッシュに保存されます。
例題
次の例で、$ds.Persons.all() は、先頭エンティティをそのすべての属性とともにロードします。 その後リクエストの最適化がおこなわれ、firstname と address.city のみがロードされます。
address.city は、Persons データクラスのキャッシュにロードされることに注意してください。
Address データクラスの先頭エンティティだけがキャッシュに格納されます。 先頭エンティティは、ループの最初の繰り返しでロードされます。
var $ds : 4D.DataStoreImplementation
var $persons : cs.PersonsSelection
var $p : cs.PersonsEntity
var $cachePersons; $cacheAddress : Object
var $text : Text
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$persons:=$ds.Persons.all()
$text:=""
For each ($p; $persons)
$text:=$p.firstname+" lives in "+$p.address.city+" / "
End for each
$cachePersons:=$ds.Persons.getRemoteCache()
$cacheAddress:=$ds.Adress.getRemoteCache()
参照
.setRemoteCacheSettings()
.clearRemoteCache()
.new()
履歴
| リリース | 内容 |
|---|---|
| 17 | 追加 |
.new() : 4D.Entity
| 引数 | 型 | 説明 | |
|---|---|---|---|
| 戻り値 | 4D.Entity | <- | データクラスの新規エンティティ |
|
説明
.new() 関数は、 メモリ内にデータクラスに空のエンティティを新規作成しそれを返します。
エンティティオブジェクトはメモリ内に作成されますが、.save( ) 関数が呼び出されるまでデータベースには保存されません。 エンティティを保存する前に削除した場合、復元することはできません。
4D Server: クライアント/サーバーにおいては、対応するテーブルのプライマリーキーが自動インクリメントであった場合、エンティティがサーバー側に保存されたときに計算されます。
エンティティの全属性は null 値で初期化されます。
4Dデータベースのストラクチャーレベルで ヌル値を空値にマップ オプションが選択されていれば、属性はデフォルト値で初期化されます。
例題
以下のコードは "Log" データクラスに新しいエンティティを作成し、"info" 属性に情報を記録します:
var $entity : cs.LogEntity
$entity:=ds.Log.new() // 参照を作成します
$entity.info:="New entry" // 情報を格納します
$entity.save() // エンティティを保存します
.newSelection()
履歴
| リリース | 内容 |
|---|---|
| 17 | 追加 |
.newSelection( { keepOrder : Integer } ) : 4D.EntitySelection
| 引数 | 型 | 説明 | |
|---|---|---|---|
| keepOrder | Integer | -> | dk keep ordered: 順列ありのエンティティセレクションを作成しますdk non ordered (あるいは省略時): 順列なしのエンティティセレクションを作成します |
| 戻り値 | 4D.EntitySelection | <- | データクラスの空の新規エンティティセレクション |
|
説明
.newSelection() 関数は、 データクラスに紐づいた 追加可能な、空の新規エンティティセレクションをメモリ内に作成します。
追加可能なエンティティセレクションについての詳細は 共有可能/追加可能なエンティティセレクション を参照ください。
順列ありのエンティティセレクションを作成するには、keepOrder に dk keep ordered セレクターを渡します。 この引数を省略した場合のデフォルト、あるいは dk non ordered セレクターを渡した場合には、関数は順列なしのエンティティセレクションを返します。 順列なしのエンティティセレクションの方が速いですが、エンティティの位置に頼ることはできません。 詳細については、エンティティセレクションの順列あり/順列なし を参照ください。
作成された時点では、エンティティセレクションにエンティティは含まれていません(mySelection.length は0を返します)。 あとから add() 関数を呼び出すことで、エンティティセレクションを徐々にビルドしていくことができます。
例題
var $USelection; $OSelection : cs.EmployeeSelection
$USelection:=ds.Employee.newSelection() // 順列なしの空のエンティティセレクションを作成します
$OSelection:=ds.Employee.newSelection(dk keep ordered) // 順列ありの空のエンティティセレクションを作成します
.query()
履歴
| リリース | 内容 |
|---|---|
| 17 R6 | Formula パラメーターをサポート |
| 17 R5 | 値のプレースホルダーをサポート |
| 17 | 追加 |
.query( queryString : Text { ; ...value : any } { ; querySettings : Object } ) : 4D.EntitySelection
.query( formula : Object { ; querySettings : Object } ) : 4D.EntitySelection
| 引数 | 型 | 説明 | |
|---|---|---|---|
| queryString | Text | -> | 検索条件 (文字列) |
| formula | Object | -> | 検索条件 (フォーミュラオブジェクト) |
| value | any | -> | プレースホルダー用の値 |
| querySettings | Object | -> | クエリオプション: parameters, attributes, args, allowFormulas, context, queryPath, queryPlan |
| 戻り値 | 4D.EntitySelection | <- | queryString または formula に渡した検索条件に合致するエンティティから構成された新しいエンティティセレクション |
|
説明
.query() 関数は、 データクラスの全エンティティから、queryString または formula と任意の value 引数で指定した検索条件に合致するエンティティを検索します。戻り値は、見つかったエンティティをすべて格納する EntitySelection 型の新しいオブジェクトです。 この関数には、レイジーローディングが適用されます。
エンティティが見つからない場合、空のエンティティセレクションが返されます。
queryString 引数
queryString 引数には、以下のシンタックスを使用します:
attributePath|formula 比較演算子 値
{論理演算子 attributePath|formula 比較演算子 値}
{order by attributePath {desc | asc}}
詳細は以下の通りです:
- attributePath: クエリの実行対象となる属性パス。 この引数は、単純な名前 ("country" など) のほか、あらゆる有効な属性パス ("country.name" など) の形をとることができます。 属性パスが
Collection型である場合、すべてのオカレンスを管理するには[]記法を使用してください (例:children[].ageなど)。
".", "[ ]", や "=", ">", "#"..., などの特殊文字はクエリ文字列の中で正しく評価されないため、これらが含まれた属性名を直接使用することはできません。 このような属性をクエリするには、プレースホルダーの使用を検討します。これにより、属性パス内で使用できる文字の範囲が広がります (後述の プレースホルダーの使用 参照)。
-
formula: テキストまたはオブジェクト形式で渡された有効なフォーミュラ。 フォーミュラは処理されるエンティティごとに評価され、ブール値を返さなくてはなりません。 処理中のエンティティはフォーミュラ内において
Thisで参照されます。- テキスト: フォーミュラ文字列の前に
eval( )ステートメントが必要です。これにより、クエリが式を正しく解釈します。 例: "eval(length(This.lastname) >=30)" - オブジェクト: フォーミュラオブジェクト は プレースホルダー (後述参照) を使って受け渡します。 このフォーミュラは、
FormulaまたはFormula from stringコマンドによって作成されたものでなくてはなりません。
- テキスト: フォーミュラ文字列の前に
- 4Dフォーミュラは、
&および|記号のみを論理演算子としてサポートすることに留意が必要です。- フォーミュラ以外にも検索条件がある場合、クエリエンジンの最適化によってほかの検索条件 (たとえばインデックス属性) の処理が優先される場合があり、その場合はエンティティのサブセットのみがフォーミュラの評価対象となります。
クエリに使用するフォーミュラは $1 に引数を受け取ることができます。 詳細については後述の フォーミュラ引数 を参照ください。
- フォーミュラが複雑な場合など、
queryStringパラメーターを使わずに、formulaパラメーターにオブジェクトを直接渡すこともできます。 後述の フォーミュラ引数 を参照ください。- セキュリティのため、
query()関数内のフォーミュラ使用を禁止することができます。querySettingsパラメーターの説明を参照ください。
- 比較演算子: attributePath 引数と value 引数の比較に使用する記号 以下の記号がサポートされます:
| 比較 | 記号 | 説明 |
|---|---|---|
| 等しい | =, == | 一致するデータを取得します。ワイルドカード (@) をサポートし、文字の大小/アクセントの有無は区別しません。 |
| ===, IS | 一致するデータを取得します。ワイルドカード (@) は標準の文字として認識され、文字の大小/アクセント記号の有無は区別しません。 | |
| 等しくない | #, != | ワイルドカード (@) をサポートします。 "宣言に Not 条件を適用" と同じです (後述参照) |
| !==, IS NOT | ワイルドカード (@) は標準の文字として認識されます | |
| 宣言に Not 条件を適用 | NOT | 複数の演算子が含まれる宣言の前に NOT を使用する場合にはカッコをつける必要があります。 "等しくない" と同じです (後述参照) |
| 小さい | < | |
| 大きい | > | |
| 以下 | <= | |
| 以上 | >= | |
| 含まれる | IN | コレクション、あるいは複数の値のうち、どれか一つの値と等しいデータを取得します。ワイルドカード (@) をサポートします。 |
| キーワードを含む | % | キーワードは、文字列あるいはピクチャー型の属性内で使用されるものが対象です。 |
- 値: コレクションの各要素、あるいはエンティティセレクションの各エンティティのプロパティのカレント値に対して比較する値。 プレースホルダー (後述の プレースホルダーの使用 参照) か、あるいはデータ型プロパティと同じ型の式を使用することができます。 定数値を使用する場合、以下の原則に従う必要があります:
- テキスト テキスト型の定数値の場合は単一引用符つき、あるいはなしでも渡すことができます(後述の 引用符を使用する 参照)。 文字列中の文字列を検索する ("含まれる" クエリ) には、ワイルドカード記号 (@) を使用して検索文字列を指定します (例: "@Smith@")。 また以下のキーワードはテキスト定数においては使用できません: true, false。
- ブール 型の定数値: true または false (文字の大小を区別します)
- 数値 型の定数値: 浮動小数点は '.' (ピリオド) で区切られます。
- 日付 型の定数値: "YYYY-MM-DD" フォーマット。
- null 定数値: "null" キーワードを使用した場合、null と undefined プロパティの両方が検索されます。
- IN 記号を使用したクエリの場合、値 はコレクションか、attributePath の型に合致する、[ ] でくくられたカンマ区切りの値である必要があります (文字列においては、
"の記号は\でエスケープする必要があります)。
- 論理演算子: 複数の条件をクエリ内で結合させるのに使用します(任意)。 以下の論理演算子のいずれか一つを使用できます (名前あるいは記号のどちらかを渡します):
| 結合 | 記号 |
|---|---|
| AND | &, &&, and |
| OR | |,||, or |
- order by attributePath: クエリに "order by attributePath" ステートメントを追加することで、結果をソートすることができます。 カンマで区切ることで、複数の order by ステートメントを使用することもできます (例: order by attributePath1 desc, attributePath2 asc)。 デフォルトの並び順は昇順です。 並び順を指定するには、降順の場合は 'desc'、昇順の場合は 'asc' を追加します。 >このステートメントを使用した場合、順序ありエンティティセレクションが返されます (詳細については エンティティセレクションの順列あり/順列なし を参照ください)。
引用符を使用する
クエリ内で引用符を使用する場合、クエリ内においては単一引用符 ' ' を使用し、クエリ全体をくくるには二重引用符 " " を使用します。クオートを混同するとエラーが返されます。 例:
"employee.name = 'smith' AND employee.firstname = 'john'"
単一引用符 (') は、クエリ文字列を分解してしまうため、検索値としてはサポートされていません。 たとえば、"comp.name = 'John's pizza' " はエラーを生成します。 単一引用符を含む値を検索するには、プレースホルダーを使用します (後述参照)。
カッコを使用する
クエリ内でカッコを使用すると、計算に優先順位をつけることができます。 たとえば、以下のようにクエリを整理することができます:
"(employee.age >= 30 OR employee.age <= 65) AND (employee.salary <= 10000 OR employee.status = 'Manager')"
プレースホルダーを使用する
4D では、queryString 引数内の attributePath、formula および 値 にプレースホルダーを使用することができます。 プレースホルダーとは、クエリ文字列に挿入するパラメーターで、クエリ文字列が評価される際に他の値で置き換えられるものです。 プレースホルダーの値はクエリ開始時に一度だけ評価されます。 各要素に対して毎回評価されるわけではありません。
プレースホルダーには二つの種類があります。インデックスプレースホルダー および 命名プレースホルダー です:
| インデックスプレースホルダー | 命名プレースホルダー | |
|---|---|---|
| 定義 | queryString に :paramIndex (例 :1, :2...) という形式でパラメーターが挿入され、それに対応する値は後に続く value 引数が提供します。 最大で 128個の value 引数を渡すことができます。 | :paramName (例: myparam など) という形でパラメーターが挿入され、その値は querySettings 引数の attributes または parameters オブジェクトで提供されます。 |
| 例題 | $r:=class.query(":1=:2";"city";"Chicago") | $o.attributes:=New object("att";"city")$o.parameters:=New object("name";"Chicago")$r:=class.query(":att=:name";$o) |
queryString には、すべての種類の引数を混ぜて渡すことができます。 queryString 引数は、attributePath と formula と 値 に以下のものを含めることができます:
- 定数値 (プレースホルダーを使用しない)
- インデックスプレースホルダーや命名プレースホルダー
以下の理由から、クエリでのプレースホルダーの使用が 推奨されます:
- 悪意あるコードの挿入を防ぎます: ユーザーによって値が代入された変数をクエリ文字列として直接使用した場合、余計なクエリ引数を入力することでユーザーがクエリ条件を変更する可能性があります。 たとえば、以下のようなクエリ文字列を考えます:
$vquery:="status = 'public' & name = "+myname // ユーザーが自分の名前を入力します
$result:=$col.query($vquery)
非公開のデータがフィルタリングされているため、このクエリは一見安全なように見えます。 しかしながら、もしユーザーが myname に smith OR status='private' のような入力をした場合、クエリ文字列は解釈時に変更され、非公開データも返してしまう可能性があります。
プレースホルダーを使用した場合、セキュリティ条件を上書きすることは不可能です:
$result:=$col.query("status='public' & name=:1";myname)
この場合、ユーザーが myname エリアに smith OR status='private' と入力した場合でも、それはクエリ文字列とはみなされず、値として渡されるだけです。 "smith OR status='private' " という名前の人物を検索したところで、結果は失敗に終わるだけです。
-
フォーマットや文字の問題を心配する必要がありません。これは、attributePath や 値 がたとえば "."、"[' ...などの英数字でない文字を格納している可能性がある場合にとくに有用です。
-
クエリに変数や式を使用することができます。 例:
$result:=$col.query("address.city = :1 & name =:2";$city;$myVar+"@")
$result2:=$col.query("company.name = :1";"John's Pizzas")
null値を検索する
null値を検索する場合、プレースホルダーシンタックスは使用できません。 なぜならクエリエンジンは null を予期せぬ比較値としてみなすからです。 たとえば、以下のクエリを実行した場合:
$vSingles:=ds.Person.query("spouse = :1";Null) // 機能しません
この場合 4D は null値を、引数の評価 (別のクエリから渡された属性など) に起因するエラーと解釈するため、期待した結果は得られません。 このようなクエリをおこなうには、直接的なシンタックスを使用する必要があります:
$vSingles:=ds.Person.query("spouse = null") // 正しいシンタックス
コレクションにおける "等しくない"
コレクションを含むデータクラス属性内を検索する場合、"値 と等しくない" 比較演算子 (# または !=) は、すべてのプロパティが 値 と異なる要素を検索します (ほかの比較演算子とは異なり、少なくとも 1つのプロパティが 値 と異なる要素は検索しません)。 つまり、"Not(プロパティ値が value と等しいコレクション要素を検索する)" を検索することと同じです。 たとえば、以下のような エンティティがあるとき:
エンティティ1:
ds.Class.name: "A"
ds.Class.info:
{ "coll" : [ {
"val":1,
"val":1
} ] }
エンティティ2:
ds.Class.name: "B"
ds.Class.info:
{ "coll" : [ {
"val":1,
"val":0
} ] }
エンティティ3:
ds.Class.name: "C"
ds.Class.info:
{ "coll" : [ {
"val":0,
"val":0
} ] }
次のような結果になります:
ds.Class.query("info.coll[].val = :1";0)
// B と C を返します
// "少なくとも 1つの valプロパティ値が 0 と等しいエンティティ" を探します
ds.Class.query("info.coll[].val != :1";0)
// A のみを返します
// "すべての valプロパティ値が 0 と異なるエンティティ" を探します
// これは、次のクエリと同義です:
ds.Class.query(not("info.coll[].val = :1";0))
"少なくとも 1つのプロパティが 値 と異なる" エンティティを検索するクエリを実装したい場合は、 [] に文字を入れた特別な表記を使用する必要があります:
ds.Class.query("info.coll[a].val != :1";0)
// A と B を返します
// "少なくとも 1つの valプロパティ値が 0 と異なるエンティティ" を探します
[a] 表記には、どのローマ字でも使用可能です。
コレクション要素とクエリ条件をリンクする
この機能は、データクラスおよび エンティティセレクション をクエリする場合にのみ利用可能です。 コレクション をクエリする場合には利用できません。
コレクションを含むデータクラス属性を対象に、AND 演算子で結合された複数のクエリ条件を使用して検索するにあたって、検索条件に合致するプロパティが複数のコレクション要素にバラけているのではなく、一つのコレクション要素がすべてまとまっているエンティティを探したいとします。 これには、すべての条件に合致するコレクション要素のみが検出されるよう、クエリ条件をコレクション要素にリンクする必要があります。
たとえば、以下のような 2件のエンティティがあるとき:
エンティティ1:
ds.People.name: "martin"
ds.People.places:
{ "locations" : [ {
"kind":"home",
"city":"paris"
} ] }
エンティティ2:
ds.People.name: "smith"
ds.People.places:
{ "locations" : [ {
"kind":"home",
"city":"lyon"
} , {
"kind":"office",
"city":"paris"
} ] }
"locations" 属性に、"kind=home" かつ "city=paris" である要素を持つ人を探したいとします。 以下のように書いた場合:
ds.People.query("places.locations[].kind= :1 and places.locations[].city= :2";"home";"paris")
... クエリは "martin" と "smith" の両方を返します。 なぜなら "smith" も "kind=home" である "location" 要素を持っており、"city=paris" である "location" 要素をも持っているからです (ですがこれら 2つは異なるコレクション要素です)。
検索条件に合致する属性が同一のコレクション要素に含まれるエンティティのみを取得するには、クエリ条件をリンク します。 クエリ条件をリンクするには:
- リンクする最初のクエリ条件にてパスの [] 内に文字を追加し、同様に他のクエリ条件でも同じ文字を追加します。 例:
locations[a].city and locations[a].kind。 ローマ字であればどの文字でも使用可能です (文字の大小は区別されません)。 - 同じクエリ内に、異なるリンク条件を追加するには、別の文字を使用します。 単一のクエリ内では、最大で 26組のリンク条件を使用することができます。
上記の 2件のエンティティにおいて、以下のように書いた場合:
ds.People.query("places.locations[a].kind= :1 and places.locations[a].city= :2";"home";"paris")
... クエリは、"kind=home" かつ "city=paris" である "locations" 要素を持つエンティティ "martin" のみを返します。 "home" と "paris" が同じコレクション要素内にない "smith" は、クエリの結果に含まれません。
N対Nリレーションのクエリ
ORDA は、N対Nリレーションにおけるクエリを容易にするための特別な構文を提供します。 このような場合には AND 演算子を使って、同じ属性内に格納されている異なる値を検索する必要があるかもしれません。 たとえば、以下のようなストラクチャーの場合を考えます:
俳優 A と俳優 B の 両方 が出演している映画をすべて検索したいとします。 AND 演算子を使った単純なクエリを書いても、うまくいきません:
// 無効なコード
$es:=ds.Movie.query("roles.actor.lastName = :1 AND roles.actor.lastName = :2";"Hanks";"Ryan")
// $es is empty
基本的に、この問題はクエリの内部ロジックに関連しています。 値が "A" と "B" の両方である属性を検索することはできません。
このようなクエリを実行するために、ORDA では特別な構文を用意しています。 具体的には、文字列内で使用される追加のリレート属性すべてにおいて、{} の間に クラスインデックス を追加します:
"relationAttribute.attribute = :1 AND relationAttribute{x}.attribute = :2 [AND relationAttribute{y}.attribute...]"
{x} は、リレーション属性のために新たな参照を作成するよう、ORDA に指示します。 すると、ORDA は必要なビットマップ操作を内部で実行します。 x には 0 以外 の任意の数値を使用できます: {1}、{2}、{1540}...。 ORDA は、各クラスインデックス用の一意な参照をクエリ内においてのみ必要とします。
この例では、次のようになります:
// 有効なコード
$es:=ds.Movie.query("roles.actor.lastName = :1 AND roles.actor{2}.lastName = :2";"Hanks";"Ryan")
// $es には映画が格納されます (You've Got Mail, Sleepless in Seattle, Joe Versus the Volcano)
formula 引数
queryString 引数にフォーミュラを挿入 (上記参照) する代わりに、formula オブジェクトをブール検索条件として直接渡すことができます。 トークナイズの利点を生かせる、コードが検索しやすく読みやすい、などといった面から、クエリにおけるフォーミュラオブジェクトの使用は 推奨されています。
このフォーミュラは、Formula または Formula from string コマンドによって作成されたものでなくてはなりません。 この場合において:
- フォーミュラは処理されるエンティティごとに評価され、true または false を返さなくてはなりません。 クエリの実行中、フォーミュラの結果がブール値でなかった場合、それは false であるとみなされます。
- 処理中のエンティティはフォーミュラ内において
Thisで参照されます。 Formulaオブジェクトが null の場合、エラー1626 ("テキストまたはフォーミュラが必要です") が生成されます。
セキュリティのため、
query()関数内のフォーミュラ使用を禁止することができます。 querySettings パラメーターの説明を参照ください。
フォーミュラに引数を渡す
query() クラス関数によって呼び出される フォーミュラ は、引数を受け取ることができます:
- 引数は、querySettings 引数の args プロパティ (オブジェクト) を通して渡さなければなりません。
- フォーミュラは args オブジェクトを $1 に受け取ります。
以下の短いコードは、引数をメソッドに渡す仕組みを示しています:
$settings:=New object("args";New object("exclude";"-")) // 引数を渡すための args オブジェクト
$es:=ds.Students.query("eval(checkName($1.exclude))";$settings) // $1 が args を受け取ります
さらなる使用例は、例題3にて紹介されています。
4D Server: クライアント/サーバーにおいては、フォーミュラはサーバー上で実行されます。 このコンテキストにおいては、querySettings.args オブジェクトのみがフォーミュラに送信されます。
querySettings 引数
querySettings 引数は、追加のオプションを格納したオブジェクトです。 以下のプロパティがサポートされています:
| プロパティ | 型 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|
| parameters | Object | queryString または formula に 値の命名プレースホルダー を使用した場合に渡すオブジェクト。 値は、プロパティ/値のペアで表現されます。プロパティは、queryString または formula に値の代わりに挿入されたプレースホルダー名 (":placeholder"など) で、値は、実際に比較される値です。 インデックスプレースホルダー (value引数として値を直接渡す方法) と命名プレースホルダーは、同じクエリ内で同時に使用することができます。 | ||||||
| attributes | Object | queryString または formula に 属性パスの命名プレースホルダー を使用した場合に渡すオブジェクト。 属性パスは、プロパティ/値のペアで表現されます。プロパティは、queryString または formula に属性パスの代わりに挿入されたプレースホルダー名 (":placeholder"など) で、値は、属性パスを表す文字列または文字列のコレクションです。 値には、データクラスのスカラー属性・リレート属性・オブジェクトフィールド内のプロパティへの属性パスを指定することができます。
| ||||||
| args | Object | フォーミュラに渡す引数。 args オブジェクトは、フォーミュラ内の $1 が受け取るので、その値は $1.property という形で利用可能です (例題3 参照)。 | ||||||
| allowFormulas | Boolean | クエリ内でフォーミュラの呼び出しを許可するには true (デフォルト)。 フォーミュラ実行を禁止するには false を渡します。 false に設定されているときに、フォーミュラが query() に渡された場合、エラーが発生します (1278 - フォーミュラはこのメンバーメソッドでは許可されていません)。 | ||||||
| context | Text | エンティティセレクションに適用されている自動の最適化コンテキストのラベル。 エンティティセレクションを扱うコードはこのコンテキストを使うことで最適化の恩恵を受けます。 この機能はクライアント/サーバー処理を想定して設計されています。 詳細な情報については、クライアント/サーバーの最適化 の章を参照ください。 | ||||||
| queryPlan | Boolean | 戻り値のエンティティコレクションに、実行する直前のクエリの詳細 (クエリプラン) を含めるかどうかを指定します。 返されるプロパティは、クエリプラン あるいはサブクエリ (複合クエリの場合) を格納したオブジェクトです。 このオプションはアプリケーションの開発フェーズにおいて有用です。 このオプションは通常 queryPath と組み合わせて使用されます。 省略時のデフォルト: false。 注: このプロパティは entitySelection.query() および dataClass.query() 関数においてのみサポートされます。 | ||||||
| queryPath | Boolean | 戻り値のエンティティコレクションに、実際に実行されたクエリの詳細を含めるかどうかを指定します。 返されたプロパティは、クエリで実際に使用されたパス (通常は queryPlan と同一ですが、エンジンがクエリを最適化した場合には異なる場合があります)、処理時間と検出レコード数を格納したオブジェクトです。 このオプションはアプリケーションの開発フェーズにおいて有用です。 省略時のデフォルト: false。 注: このプロパティは entitySelection.query() および dataClass.query() 関数においてのみサポートされます。 |
queryPlan と queryPath について
queryPlan/queryPath に格納される情報には、クエリの種類 (インデックスあるいはシーケンシャル)、必要なサブクエリおよびその連結演算子が含まれます。 クエリパスには、見つかったエンティティの数と各検索条件を実行するににかかった時間も含まれます。 この情報は、アプリケーションの開発中に解析することで有効に活用できます。 一般的には、クエリプランとクエリパスの詳細は同一になるはずですが、4D はパフォーマンス向上のために動的な最適化をクエリ実行時に実装することがあり、異なることもあります。 たとえば、その方が早いと判断した場合には、4Dエンジンはインデックス付きクエリをシーケンシャルなものへと動的に変換することがあります。 これは検索されているエンティティの数が少ないときに起こりえます。
たとえば、以下のクエリを実行した場合:
$sel:=ds.Employee.query("salary < :1 and employer.name = :2 or employer.revenues > :3";\
50000;"Lima West Kilo";10000000;New object("queryPath";True;"queryPlan";True))
queryPlan:
{Or:[{And:[{item:[index : Employee.salary ] < 50000},
{item:Join on Table : Company : Employee.employerID = Company.ID,
subquery:[{item:[index : Company.name ] = Lima West Kilo}]}]},
{item:Join on Table : Company : Employee.employerID = Company.ID,
subquery:[{item:[index : Company.revenues ] > 10000000}]}]}
queryPath:
{steps:[{description:OR,time:63,recordsfounds:1388132,
steps:[{description:AND,time:32,recordsfounds:131,
steps:[{description:[index : Employee.salary ] < 50000,time:16,recordsfounds:728260},{description:Join on Table : Company : Employee.employerID = Company.ID,time:0,recordsfounds:131,
steps:[{steps:[{description:[index : Company.name ] = Lima West Kilo,time:0,recordsfounds:1}]}]}]},{description:Join on Table : Company : Employee.employerID = Company.ID,time:31,recordsfounds:1388132,
steps:[{steps:[{description:[index : Company.revenues ] > 10000000,time:0,recordsfounds:933}]}]}]}]}
例題 1
この例題では、様々なクエリの例を紹介します。
文字列のクエリ:
$entitySelection:=ds.Customer.query("firstName = 'S@'")
NOT節を用いたクエリ:
$entitySelection:=ds.Employee.query("not(firstName=Kim)")
日付のクエリ:
$entitySelection:=ds.Employee.query("birthDate > :1";"1970-01-01")
$entitySelection:=ds.Employee.query("birthDate <= :1";Current date-10950)
値のインデックスプレースホルダーを使用したクエリ:
$entitySelection:=ds.Customer.query("(firstName = :1 or firstName = :2) and (lastName = :3 or lastName = :4)";"D@";"R@";"S@";"K@")
リレートデータクラス対して値のインデックスプレースホルダーを使用したクエリ:
$entitySelection:=ds.Employee.query("lastName = :1 and manager.lastName = :2";"M@";"S@")
降順の order by ステートメントを含んだ、インデックスプレースホルダーを使用したクエリ:
$entitySelection:=ds.Student.query("nationality = :1 order by campus.name desc, lastname";"French")
値の命名プレースホルダーを使用したクエリ:
var $querySettings : Object
var $managedCustomers : cs.CustomerSelection
$querySettings:=New object
$querySettings.parameters:=New object("userId";1234;"extraInfo";New object("name";"Smith"))
$managedCustomers:=ds.Customer.query("salesperson.userId = :userId and name = :extraInfo.name";$querySettings)
値の命名プレースホルダーと、値のインデックスプレースホルダーの両方を使用したクエリ:
var $querySettings : Object
var $managedCustomers : cs.CustomerSelection
$querySettings.parameters:=New object("userId";1234)
$managedCustomers:=ds.Customer.query("salesperson.userId = :userId and name=:1";"Smith";$querySettings)
queryPlan および queryPath オブジェクトを返すクエリ:
$entitySelection:=ds.Employee.query("(firstName = :1 or firstName = :2) and (lastName = :3 or lastName = :4)";"D@";"R@";"S@";"K@";New object("queryPlan";True;"queryPath";True))
// 戻り値のエンティティセレクションから以下のプロパティを取得できます
var $queryPlan; $queryPath : Object
$queryPlan:=$entitySelection.queryPlan
$queryPath:=$entitySelection.queryPath
コレクション型の属性パスを用いたクエリ:
$entitySelection:=ds.Employee.query("extraInfo.hobbies[].name = :1";"horsebackriding")
コレクション型の属性パスとクエリ条件をリンクしたクエリ:
$entitySelection:=ds.Employee.query("extraInfo.hobbies[a].name = :1 and extraInfo.hobbies[a].level=:2";"horsebackriding";2)
コレクション型の属性パスとクエリ条件を、複数リンクしたクエリ:
$entitySelection:=ds.Employee.query("extraInfo.hobbies[a].name = :1 and
extraInfo.hobbies[a].level = :2 and extraInfo.hobbies[b].name = :3 and
extraInfo.hobbies[b].level = :4";"horsebackriding";2;"Tennis";5)
オブジェクト型の属性パスを用いたクエリ:
$entitySelection:=ds.Employee.query("extra.eyeColor = :1";"blue")
IN節を用いたクエリ:
$entitySelection:=ds.Employee.query("firstName in :1";New collection("Kim";"Dixie"))
NOT (IN) 節を用いたクエリ:
$entitySelection:=ds.Employee.query("not (firstName in :1)";New collection("John";"Jane"))
属性パスのインデックスプレースホルダーを使用したクエリ:
var $es : cs.EmployeeSelection
$es:=ds.Employee.query(":1 = 1234 and :2 = 'Smith'";"salesperson.userId";"name")
// salesperson はリレートエンティティです
属性パスのインデックスプレースホルダーと、値の命名プレースホルダーを使用したクエリ:
var $es : cs.EmployeeSelection
var $querySettings : Object
$querySettings:=New object
$querySettings.parameters:=New object("customerName";"Smith")
$es:=ds.Customer.query(":1 = 1234 and :2 = :customerName";"salesperson.userId";"name";$querySettings)
// salesperson はリレートエンティティです
属性パスと値のインデックスプレースホルダーを使用したクエリ:
var $es : cs.EmployeeSelection
$es:=ds.Clients.query(":1 = 1234 and :2 = :3";"salesperson.userId";"name";"Smith")
// salesperson はリレートエンティティです
例題 2
この例題では、属性パスの命名プレースホルダーを使用するクエリを紹介します。
2件のエンティティをもつ Employee データクラスを前提に考えます:
エンティティ1:
name: "Marie"
number: 46
softwares:{
"Word 10.2": "Installed",
"Excel 11.3": "To be upgraded",
"Powerpoint 12.4": "Not installed"
}
エンティティ2:
name: "Sophie"
number: 47
softwares:{
"Word 10.2": "Not installed",
"Excel 11.3": "To be upgraded",
"Powerpoint 12.4": "Not installed"
}
属性パスの命名プレースホルダーを使用したクエリ:
var $querySettings : Object
var $es : cs.EmployeeSelection
$querySettings:=New object
$querySettings.attributes:=New object("attName";"name";"attWord";New collection("softwares";"Word 10.2"))
$es:=ds.Employee.query(":attName = 'Marie' and :attWord = 'Installed'";$querySettings)
//$es.length=1 (Employee Marie)
属性パスと値の命名プレースホルダーを使用したクエリ:
var $querySettings : Object
var $es : cs.EmployeeSelection
var $name : Text
$querySettings:=New object
// 値の命名プレースホルダー
// ユーザーに検索する名前を入力してもらいます
$name:=Request("検索する名前を入力してください:")
If(OK=1)
$querySettings.parameters:=New object("givenName";$name)
// 属性パスの命名プレースホルダー
$querySettings.attributes:=New object("attName";"name")
$es:=ds.Employee.query(":attName= :givenName";$querySettings)
End if
例題 3
この例題では、クエリにおいて、引数あり・引数なしでフォーミュラを使用する様々な方法を紹介します。
eval() を使い、テキストとしてフォーミュラを queryString パラメーターに渡すクエリ:
var $es : cs.StudentsSelection
$es:=ds.Students.query("eval(length(This.lastname) >=30) and nationality='French'")
プレースホルダーを使い、Formulaオブジェクトとしてフォーミュラを渡すクエリ:
var $es : cs.StudentsSelection
var $formula : Object
$formula:=Formula(Length(This.lastname)>=30)
$es:=ds.Students.query(":1 and nationality='French'";$formula)
Formula オブジェクトのみを検索条件として渡したクエリ:
var $es : cs.StudentsSelection
var $formula : Object
$formula:=Formula(Length(This.lastname)>=30)
$es:=ds.Students.query($formula)
フォーミュラを複数適用したクエリ:
var $formula1; $1; $formula2 ;$0 : Object
$formula1:=$1
$formula2:=Formula(Length(This.firstname)>=30)
$0:=ds.Students.query(":1 and :2 and nationality='French'";$formula1;$formula2)
queryString のテキストフォーミュラが引数を受け取るクエリ:
var $es : cs.StudentsSelection
var $settings : Object
$settings:=New object()
$settings.args:=New object("filter";"-")
$es:=ds.Students.query("eval(checkName($1.filter)) and nationality=:1";"French";$settings)
// checkName メソッド
#DECLARE($exclude : Text) -> $result : Boolean
$result:=(Position($exclude;This.lastname)=0)
同じ checkName メソッドを Formula オブジェクトに格納してプレースホルダーで渡し、引数を受け取るクエリ:
var $es : cs.StudentsSelection
var $settings; $formula : Object
$formula:=Formula(checkName($1.filter))
$settings:=New object()
$settings.args:=New object("filter";"-")
$es:=ds.Students.query(":1 and nationality=:2";$formula;"French";$settings)
$settings.args.filter:="*" // $formula オブジェクトは更新せずに引数を変更します
$es:=ds.Students.query(":1 and nationality=:2";$formula;"French";$settings)
ユーザーがクエリを入力する場合などに、フォーミュラを禁止する場合:
var $es : cs.StudentsSelection
var $settings : Object
var $queryString : Text
$queryString:=Request("Enter your query:")
if(OK=1)
$settings:=New object("allowFormulas";False)
$es:=ds.Students.query($queryString;$settings) // $queryString にフォーミュラが格納されていた場合にはエラーが生成されます
End if
参照
エンティティセレクションの .query()
.setRemoteCacheSettings()
履歴
| リリース | 内容 |
|---|---|
| 19 R5 | 追加 |
.setRemoteCacheSettings(settings : Object)
| 引数 | 型 | 説明 | |
|---|---|---|---|
| settings | Object | -> | データクラスの ORDAキャッシュについて、タイムアウトと最大サイズを指定するオブジェクト |
|
上級者向け: この機能は、特定の構成のため、ORDAのデフォルト機能をカスタマイズする必要がある開発者向けです。 ほとんどの場合、使用する必要はないでしょう。
説明
.setRemoteCacheSettings() 関数は、 データクラスの ORDAキャッシュについて、タイムアウトと最大サイズを指定します。
settings には、以下のプロパティを持つオブジェクトを渡します:
| プロパティ | 型 | 説明 |
|---|---|---|
| timeout | Integer | タイムアウト (秒単位) |
| maxEntries | Integer | エンティティの最大数 |
timeout は、データクラスの ORDAキャッシュのタイムアウトを設定します (デフォルトは 30秒)。 タイムアウトを過ぎると、キャッシュ内のデータクラスのエンティティは期限切れとみなされます。 これは、次のことを意味します:
- データはまだ存在します
- 次にそのデータが必要になったときには、サーバーに要求します
- エンティティの最大数に達すると、4D は期限切れのデータを自動的に削除します
timeout プロパティを設定すると、すでにキャッシュに存在するエンティティに新しいタイムアウトが設定されます。 これは頻繁に変更されないデータを扱う場合、つまり、サーバーへの新たな要求が必要ない場合に便利です。
maxEntries は、ORDAキャッシュ内のエンティティの最大数を設定します。 デフォルトは 30,000 です。
最小エントリー数は 300 のため、maxEntries の値は 300以上でなくてはなりません。 それ以外の場合は無視され、最大エントリー数は 300 に設定されます。
timeout および maxEntries として有効なプロパティが渡されない場合、キャッシュはデフォルト値または以前に設定された値のまま変更されません。
エンティティが保存されると、キャッシュ内で更新され、タイムアウトに達すると期限切れとなります。
例題
var $ds : 4D.DataStoreImplementation
$ds:=Open datastore(New object("hostname"; "www.myserver.com"); "myDS")
$ds.Buildings.setRemoteCacheSettings(New object("timeout"; 60; "maxEntries"; 350))