IndexingPolicy クラス

パッケージ:

com.microsoft.azure.cosmosdb

• java.lang.Object
• • JsonSerializable
  • • com.microsoft.azure.cosmosdb.IndexingPolicy

public class IndexingPolicy extends JsonSerializable

Azure Cosmos DB データベース サービス内のコレクションのインデックス作成ポリシー構成を表します。

コンストラクターの概要

コンストラクター	説明
IndexingPolicy()	コンストラクターです。
IndexingPolicy(Index[] defaultIndexOverrides)	指定したインデックスセットをルート パスの既定のインデックス指定として使用して、IndexingPolicy クラスの新しいインスタンスを初期化します。 次の例は、ルート パスの既定の indexingPolicy をオーバーライドする方法を示しています。 HashIndex hashIndexOverride = Index.Hash(DataType.String, 5); RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2); SpatialIndex spatialIndexOverride = Index.Spatial(DataType.Point); IndexingPolicy indexingPolicy = new IndexingPolicy(hashIndexOverride, rangeIndexOverride, spatialIndexOverride); 数値の indexingPolicy だけをオーバーライドする場合は、次のように指定できます。 RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2); IndexingPolicy indexingPolicy = new IndexingPolicy(rangeIndexOverride);
IndexingPolicy(String jsonString)	コンストラクターです。

メソッドの概要

修飾子と型	メソッドと説明
Boolean	getAutomatic() コレクションに対して自動インデックス作成が有効かどうかを取得します。 自動インデックス作成では、RequestOptions を使用してドキュメントをインデックス作成から明示的に除外できます。 手動インデックス作成では、ドキュメントを明示的に含めることができます。
Collection<ArrayList<CompositePath>>	getCompositeIndexes() 追加のインデックスの複合インデックスを取得します。
Collection<ExcludedPath>	getExcludedPaths() インデックスが作成されていないパスを取得します。
Collection<IncludedPath>	getIncludedPaths() ユーザーがインデックスを作成するために選択したパスを取得します。
IndexingMode	getIndexingMode() インデックス作成モード (整合性または遅延) を取得します。
Collection<SpatialSpec>	getSpatialIndexes() 追加のインデックスの空間インデックスを設定します。
void	setAutomatic(boolean automatic) コレクションに対して自動インデックス作成を有効にするかどうかを設定します。 自動インデックス作成では、RequestOptions を使用してドキュメントをインデックス作成から明示的に除外できます。 手動インデックス作成では、ドキュメントを明示的に含めることができます。
void	setCompositeIndexes(Collection<ArrayList<CompositePath>> compositeIndexes) 追加のインデックスの複合インデックスを設定します。
void	setExcludedPaths(Collection<ExcludedPath> excludedPaths)
void	setIncludedPaths(Collection<IncludedPath> includedPaths)
void	setIndexingMode(IndexingMode indexingMode) インデックス作成モード (整合性または遅延) を設定します。
void	setSpatialIndexes(Collection<SpatialSpec> spatialIndexes) 追加のインデックスの空間インデックスを設定します。

継承メンバー

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

コンストラクターの詳細

IndexingPolicy

public IndexingPolicy()

コンストラクターです。

IndexingPolicy

public IndexingPolicy(Index[] defaultIndexOverrides)

指定したインデックスセットをルート パスの既定のインデックス指定として使用して、IndexingPolicy クラスの新しいインスタンスを初期化します。

次の例は、ルート パスの既定の indexingPolicy をオーバーライドする方法を示しています。

HashIndex hashIndexOverride = Index.Hash(DataType.String, 5);
    RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2);
    SpatialIndex spatialIndexOverride = Index.Spatial(DataType.Point);
    
    IndexingPolicy indexingPolicy = new IndexingPolicy(hashIndexOverride, rangeIndexOverride, spatialIndexOverride);
    

数値の indexingPolicy だけをオーバーライドする場合は、次のように指定できます。

RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2);
    
    IndexingPolicy indexingPolicy = new IndexingPolicy(rangeIndexOverride);
    

パラメーター:

defaultIndexOverrides - ルート パスの既定のインデックス仕様として機能するインデックスのコンマ区切りセット。

IndexingPolicy

public IndexingPolicy(String jsonString)

コンストラクターです。

パラメーター:

jsonString - インデックス作成ポリシーを表す json 文字列。

メソッドの詳細

getAutomatic

public Boolean getAutomatic()

コレクションに対して自動インデックス作成が有効かどうかを取得します。

自動インデックス作成では、RequestOptions を使用してドキュメントをインデックス作成から明示的に除外できます。 手動インデックス作成では、ドキュメントを明示的に含めることができます。

戻り値:

自動

getCompositeIndexes

public Collection> getCompositeIndexes()

追加のインデックスの複合インデックスを取得します。

戻り値:

複合インデックス。

getExcludedPaths

public Collection getExcludedPaths()

インデックスが作成されていないパスを取得します。

戻り値:

除外されたパス。

getIncludedPaths

public Collection getIncludedPaths()

ユーザーがインデックスを作成するために選択したパスを取得します。

戻り値:

含まれているパス。

getIndexingMode

public IndexingMode getIndexingMode()

インデックス作成モード (整合性または遅延) を取得します。

戻り値:

インデックス作成モード。

getSpatialIndexes

public Collection getSpatialIndexes()

追加のインデックスの空間インデックスを設定します。

戻り値:

空間インデックス。

setAutomatic

public void setAutomatic(boolean automatic)

コレクションに対して自動インデックス作成を有効にするかどうかを設定します。

自動インデックス作成では、RequestOptions を使用してドキュメントをインデックス作成から明示的に除外できます。 手動インデックス作成では、ドキュメントを明示的に含めることができます。

パラメーター:

automatic - 自動

setCompositeIndexes

public void setCompositeIndexes(Collection> compositeIndexes)

追加のインデックスの複合インデックスを設定します。

パラメーター:

compositeIndexes - 複合インデックス。

setExcludedPaths

public void setExcludedPaths(Collection excludedPaths)

パラメーター:

excludedPaths

setIncludedPaths

public void setIncludedPaths(Collection includedPaths)

パラメーター:

includedPaths

setIndexingMode

public void setIndexingMode(IndexingMode indexingMode)

インデックス作成モード (整合性または遅延) を設定します。

パラメーター:

indexingMode - インデックス作成モード。

setSpatialIndexes

public void setSpatialIndexes(Collection spatialIndexes)

追加のインデックスの空間インデックスを設定します。

パラメーター:

spatialIndexes - 空間インデックス。