MongoFilters
Definição dos filtros em Bson que são utilizados nas operações das coleções do MongoDB.
all
all(campo: string, valores: java.lang.Object[]) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o array do campo especificado contém todos os valores fornecidos.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valores | java.lang.Object[] | Valores que o array deve conter. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
all(campo: string, valores: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o array do campo especificado contém todos os valores fornecidos.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valores | Values | DataSchema | java.lang.Iterable |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
and
and(filtros: org.bson.conversions.Bson[]) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que todas as condições fornecidas são verdadeiras (E lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtros | org.bson.conversions.Bson[] | Filtros a serem combinados com E lógico. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
and(filtros: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que todas as condições fornecidas são verdadeiras (E lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtros | Values | DataSchema | java.lang.Iterable |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
empty
empty() : org.bson.conversions.Bson
Descrição
Cria um filtro vazio que corresponde a todos os documentos na coleção.
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
eq
eq(valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor é igual ao valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
eq(campo: string, valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado é igual ao valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
exists
exists(campo: string) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o campo especificado existe.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
exists(campo: string, existe: boolean) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o campo especificado existe ou não, de acordo com a flag fornecida.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| existe | boolean | True para verificar se o campo existe, false para verificar se não existe. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
gt
gt(campo: string, valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado é maior que o valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
gte
gte(campo: string, valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado é maior ou igual ao valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
in
in(campo: string, valores: java.lang.Object[]) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado corresponde a qualquer um dos valores fornecidos.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valores | java.lang.Object[] | Valores a serem comparados. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
in(campo: string, valores: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado corresponde a qualquer um dos valores fornecidos na iterable.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valores | Values | DataSchema | java.lang.Iterable |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
lt
lt(campo: string, valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado é menor que o valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
lte
lte(campo: string, valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado é menor ou igual ao valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
mod
mod(campo: string, divisor: long, resto: long) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor de um campo dividido por um divisor tem o resto especificado (ou seja, executa uma operação de módulo para selecionar documentos).
Como Usar
_mongo.filters().mod('quantity', 5, 2);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| divisor | long | O módulo da operação. |
| resto | long | O resto da operação. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
ne
ne(campo: string, valor: java.lang.Object) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado é diferente do valor fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valor | java.lang.Object | Valor a ser comparado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
nin
nin(campo: string, valores: java.lang.Object[]) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado não corresponde a nenhum dos valores fornecidos.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valores | java.lang.Object[] | Valores a serem comparados. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
nin(campo: string, valores: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado não corresponde a nenhum dos valores fornecidos na iterable.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| valores | Values | DataSchema | java.lang.Iterable |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
nor
nor(filtros: org.bson.conversions.Bson[]) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que nenhuma das condições fornecidas é verdadeira (NÃO OU lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtros | org.bson.conversions.Bson[] | Filtros a serem combinados com NÃO OU lógico. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
nor(filtros: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que nenhuma das condições fornecidas é verdadeira (NÃO OU lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtros | Values | DataSchema | java.lang.Iterable |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
not
not(filtro: org.bson.conversions.Bson) : org.bson.conversions.Bson
Descrição
Cria um filtro que nega o filtro fornecido (NÃO lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Filtro a ser negado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
or
or(filtros: org.bson.conversions.Bson[]) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que pelo menos uma das condições fornecidas é verdadeira (OU lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtros | org.bson.conversions.Bson[] | Filtros a serem combinados com OU lógico. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
or(filtros: Values | DataSchema | java.lang.Iterable) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que pelo menos uma das condições fornecidas é verdadeira (OU lógico).
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtros | Values | DataSchema | java.lang.Iterable |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
regex
regex(campo: string, padrão: string) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo corresponde ao padrão de expressão regular fornecido.
Como Usar
_mongo.filters().regex('fieldName', 'regex');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| padrão | string | Expressão regular. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
regex(campo: string, padrão: string, opções: string) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo corresponde ao padrão de expressão regular fornecido, com as opções dadas aplicadas.
Como Usar
_mongo.filters().regex('fieldName', 'regex', 'i');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| padrão | string | Expressão regular. |
| opções | string | Opções da regex. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
regex(campo: string, padrão: java.util.regex.Pattern) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o valor do campo especificado corresponde ao padrão de expressão regular fornecido.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| padrão | java.util.regex.Pattern | Padrão de expressão regular. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
size
size(campo: string, tamanho: int) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos nos quais o valor de um campo é um array do tamanho especificado.
Como Usar
_mongo.filters().size('fieldName', '3');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| tamanho | int | Tamanho do array. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
text
text(busca: string) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos para os quais a expressão de busca em texto fornecida corresponde.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| busca | string | Texto a ser pesquisado. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
text(busca: string, opções: com.mongodb.client.model.TextSearchOptions) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos para os quais a expressão de busca em texto fornecida corresponde, com as opções de busca em texto especificadas.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| busca | string | Texto a ser pesquisado. |
| opções | com.mongodb.client.model.TextSearchOptions | Opções de busca em texto. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
type
type(campo: string, tipo: string) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o campo especificado é do tipo indicado pela string.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| tipo | string | Tipo do campo como string. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
type(campo: string, tipo: org.bson.BsonType) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos em que o campo especificado é do tipo Bson indicado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| campo | string | Nome do campo do documento. |
| tipo | org.bson.BsonType | Tipo Bson do campo. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.
where
where(expressão: string) : org.bson.conversions.Bson
Descrição
Cria um filtro que corresponde a todos os documentos para os quais a expressão fornecida é verdadeira.
Como Usar
_mongo.filters().where('javascript-expression');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| expressão | string | Expressão JavaScript. |
Retorno
( org.bson.conversions.Bson )
Retorna um filtro no formato Bson.