Freigeben über

IndexingPolicy Klasse

  • Referenz
Paket:
com.microsoft.azure.cosmosdb

public class IndexingPolicy extends JsonSerializable

Stellt die Indizierungsrichtlinienkonfiguration für eine Sammlung im Azure Cosmos DB-Datenbankdienst dar.

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
IndexingPolicy()

Konstruktor.

IndexingPolicy(Index[] defaultIndexOverrides)

Initialisiert eine neue instance der IndexingPolicy-Klasse mit dem angegebenen Satz von Indizes als Standardindexspezifikationen für den Stammpfad.

Das folgende Beispiel zeigt, wie Sie die StandardindexingPolicy für den Stammpfad außer Kraft setzen:

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);

Wenn Sie die indexingPolicy for Numbers einfach außer Kraft setzen möchten, können Sie folgendes angeben:

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

IndexingPolicy(String jsonString)

Konstruktor.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
Boolean getAutomatic()

Ruft ab, ob die automatische Indizierung für eine Auflistung aktiviert ist.

Bei der automatischen Indizierung können Dokumente mithilfe von RequestOptions explizit von der Indizierung ausgeschlossen werden. In der manuellen Indizierung können Dokumente explizit einbezogen werden.
Collection<ArrayList<CompositePath>> getCompositeIndexes()

Ruft die zusammengesetzten Indizes für zusätzliche Indizes ab.
Collection<ExcludedPath> getExcludedPaths()

Ruft die Pfade ab, die nicht indiziert sind.
Collection<IncludedPath> getIncludedPaths()

Ruft die Pfade ab, die vom Benutzer indiziert werden sollen.
IndexingMode getIndexingMode()

Ruft den Indizierungsmodus ab (konsistent oder faul).
Collection<SpatialSpec> getSpatialIndexes()

Legt die räumlichen Indizes für zusätzliche Indizes fest.
void setAutomatic(boolean automatic)

Legt fest, ob die automatische Indizierung für eine Sammlung aktiviert ist.

Bei der automatischen Indizierung können Dokumente mithilfe von RequestOptions explizit von der Indizierung ausgeschlossen werden. In der manuellen Indizierung können Dokumente explizit einbezogen werden.
void setCompositeIndexes(Collection<ArrayList<CompositePath>> compositeIndexes)

Legt die zusammengesetzten Indizes für zusätzliche Indizes fest.
void setExcludedPaths(Collection<ExcludedPath> excludedPaths)
void setIncludedPaths(Collection<IncludedPath> includedPaths)
void setIndexingMode(IndexingMode indexingMode)

Legt den Indizierungsmodus (konsistent oder faul) fest.
void setSpatialIndexes(Collection<SpatialSpec> spatialIndexes)

Legt die räumlichen Indizes für zusätzliche Indizes fest.

Geerbte Elemente

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()

Details zum Konstruktor

IndexingPolicy

public IndexingPolicy()

Konstruktor.

IndexingPolicy

public IndexingPolicy(Index[] defaultIndexOverrides)

Initialisiert eine neue instance der IndexingPolicy-Klasse mit dem angegebenen Satz von Indizes als Standardindexspezifikationen für den Stammpfad.

Das folgende Beispiel zeigt, wie Sie die StandardindexingPolicy für den Stammpfad außer Kraft setzen:

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);

Wenn Sie die indexingPolicy for Numbers einfach außer Kraft setzen möchten, können Sie folgendes angeben:

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

Parameters:

defaultIndexOverrides - durch Kommas getrennte Indizes, die als Standardindexspezifikationen für den Stammpfad dienen.

IndexingPolicy

public IndexingPolicy(String jsonString)

Konstruktor.

Parameters:

jsonString - die JSON-Zeichenfolge, die die Indizierungsrichtlinie darstellt.

Details zur Methode

getAutomatic

public Boolean getAutomatic()

Ruft ab, ob die automatische Indizierung für eine Auflistung aktiviert ist.

Bei der automatischen Indizierung können Dokumente mithilfe von RequestOptions explizit von der Indizierung ausgeschlossen werden. In der manuellen Indizierung können Dokumente explizit einbezogen werden.

Returns:

die automatische

getCompositeIndexes

public Collection<>> getCompositeIndexes()

Ruft die zusammengesetzten Indizes für zusätzliche Indizes ab.

Returns:

die zusammengesetzten Indizes.

getExcludedPaths

public Collection getExcludedPaths()

Ruft die Pfade ab, die nicht indiziert sind.

Returns:

die ausgeschlossenen Pfade.

getIncludedPaths

public Collection getIncludedPaths()

Ruft die Pfade ab, die vom Benutzer indiziert werden sollen.

Returns:

die enthaltenen Pfade.

getIndexingMode

public IndexingMode getIndexingMode()

Ruft den Indizierungsmodus ab (konsistent oder faul).

Returns:

den Indizierungsmodus.

getSpatialIndexes

public Collection getSpatialIndexes()

Legt die räumlichen Indizes für zusätzliche Indizes fest.

Returns:

die räumlichen Indizes.

setAutomatic

public void setAutomatic(boolean automatic)

Legt fest, ob die automatische Indizierung für eine Sammlung aktiviert ist.

Bei der automatischen Indizierung können Dokumente mithilfe von RequestOptions explizit von der Indizierung ausgeschlossen werden. In der manuellen Indizierung können Dokumente explizit einbezogen werden.

Parameters:

automatic - die automatische

setCompositeIndexes

public void setCompositeIndexes(Collection<>> compositeIndexes)

Legt die zusammengesetzten Indizes für zusätzliche Indizes fest.

Parameters:

compositeIndexes - die zusammengesetzten Indizes.

setExcludedPaths

public void setExcludedPaths(Collection excludedPaths)

Parameters:

excludedPaths

setIncludedPaths

public void setIncludedPaths(Collection includedPaths)

Parameters:

includedPaths

setIndexingMode

public void setIndexingMode(IndexingMode indexingMode)

Legt den Indizierungsmodus (konsistent oder faul) fest.

Parameters:

indexingMode - den Indizierungsmodus.

setSpatialIndexes

public void setSpatialIndexes(Collection spatialIndexes)

Legt die räumlichen Indizes für zusätzliche Indizes fest.

Parameters:

spatialIndexes - die räumlichen Indizes.

Gilt für: