IndexingPolicy Classe

  • Referência
Pacote:
com.microsoft.azure.cosmosdb

public class IndexingPolicy extends JsonSerializable

Representa a configuração da política de indexação para uma coleção no serviço de banco de dados do Azure Cosmos DB.

Resumo do Construtor

Construtor Description
IndexingPolicy()

Construtor.

IndexingPolicy(Index[] defaultIndexOverrides)

Inicializa uma nova instância da classe IndexingPolicy com o conjunto de índices especificado como especificações de índice padrão para o caminho raiz.

O exemplo a seguir mostra como substituir a indexingPolicy padrão para o caminho raiz:

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

Se você quiser substituir apenas a indexingPolicy para Números, poderá especificar exatamente isso:

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

IndexingPolicy(String jsonString)

Construtor.

Resumo do método

Modificador e tipo Método e descrição
Boolean getAutomatic()

Obtém se a indexação automática está habilitada para uma coleção.

Na indexação automática, os documentos podem ser explicitamente excluídos da indexação usando RequestOptions. Na indexação manual, os documentos podem ser incluídos explicitamente.
Collection<ArrayList<CompositePath>> getCompositeIndexes()

Obtém os índices compostos para índices adicionais.
Collection<ExcludedPath> getExcludedPaths()

Obtém os caminhos que não são indexados.
Collection<IncludedPath> getIncludedPaths()

Obtém os caminhos escolhidos para serem indexados pelo usuário.
IndexingMode getIndexingMode()

Obtém o modo de indexação (consistente ou lento).
Collection<SpatialSpec> getSpatialIndexes()

Define os índices espaciais para índices adicionais.
void setAutomatic(boolean automatic)

Define se a indexação automática está habilitada para uma coleção.

Na indexação automática, os documentos podem ser explicitamente excluídos da indexação usando RequestOptions. Na indexação manual, os documentos podem ser incluídos explicitamente.
void setCompositeIndexes(Collection<ArrayList<CompositePath>> compositeIndexes)

Define os índices compostos para índices adicionais.
void setExcludedPaths(Collection<ExcludedPath> excludedPaths)
void setIncludedPaths(Collection<IncludedPath> includedPaths)
void setIndexingMode(IndexingMode indexingMode)

Define o modo de indexação (consistente ou lento).
void setSpatialIndexes(Collection<SpatialSpec> spatialIndexes)

Define os índices espaciais para índices adicionais.

Membros herdados

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

Detalhes do construtor

IndexingPolicy

public IndexingPolicy()

Construtor.

IndexingPolicy

public IndexingPolicy(Index[] defaultIndexOverrides)

Inicializa uma nova instância da classe IndexingPolicy com o conjunto de índices especificado como especificações de índice padrão para o caminho raiz.

O exemplo a seguir mostra como substituir a indexingPolicy padrão para o caminho raiz:

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

Se você quiser substituir apenas a indexingPolicy para Números, poderá especificar exatamente isso:

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

Parâmetros:

defaultIndexOverrides - conjunto separado por vírgulas de índices que servem como especificações de índice padrão para o caminho raiz.

IndexingPolicy

public IndexingPolicy(String jsonString)

Construtor.

Parâmetros:

jsonString - a cadeia de caracteres json que representa a política de indexação.

Detalhes do método

getAutomatic

public Boolean getAutomatic()

Obtém se a indexação automática está habilitada para uma coleção.

Na indexação automática, os documentos podem ser explicitamente excluídos da indexação usando RequestOptions. Na indexação manual, os documentos podem ser incluídos explicitamente.

Retornos:

o automático

getCompositeIndexes

public Collection> getCompositeIndexes()

Obtém os índices compostos para índices adicionais.

Retornos:

os índices compostos.

getExcludedPaths

public Collection getExcludedPaths()

Obtém os caminhos que não são indexados.

Retornos:

os caminhos excluídos.

getIncludedPaths

public Collection getIncludedPaths()

Obtém os caminhos escolhidos para serem indexados pelo usuário.

Retornos:

os caminhos incluídos.

getIndexingMode

public IndexingMode getIndexingMode()

Obtém o modo de indexação (consistente ou lento).

Retornos:

o modo de indexação.

getSpatialIndexes

public Collection getSpatialIndexes()

Define os índices espaciais para índices adicionais.

Retornos:

os índices espaciais.

setAutomatic

public void setAutomatic(boolean automatic)

Define se a indexação automática está habilitada para uma coleção.

Na indexação automática, os documentos podem ser explicitamente excluídos da indexação usando RequestOptions. Na indexação manual, os documentos podem ser incluídos explicitamente.

Parâmetros:

automatic - o automático

setCompositeIndexes

public void setCompositeIndexes(Collection> compositeIndexes)

Define os índices compostos para índices adicionais.

Parâmetros:

compositeIndexes - os índices compostos.

setExcludedPaths

public void setExcludedPaths(Collection excludedPaths)

Parâmetros:

excludedPaths

setIncludedPaths

public void setIncludedPaths(Collection includedPaths)

Parâmetros:

includedPaths

setIndexingMode

public void setIndexingMode(IndexingMode indexingMode)

Define o modo de indexação (consistente ou lento).

Parâmetros:

indexingMode - o modo de indexação.

setSpatialIndexes

public void setSpatialIndexes(Collection spatialIndexes)

Define os índices espaciais para índices adicionais.

Parâmetros:

spatialIndexes - os índices espaciais.

Aplica-se a