Query Array Collections in Couchbase Lite Using New API

Um dos principais recursos introduzidos no Couchbase Lite 2.0é a nova interface de consulta baseada em N1QLa linguagem de consulta declarativa do Couchbase que estende o SQL para JSON. Se você estiver familiarizado com SQL, vai se sentir em casa com a semântica da nova API. Cobrimos os conceitos básicos da interface em um artigo anterior postagem no blog. As matrizes são um componente integral da modelagem de dados com JSON. Nesta postagem do blog, discutiremos a consulta de coleções de matrizes usando a nova API.

Este blog pressupõe que você esteja familiarizado com os fundamentos, portanto, se ainda não o fez, não deixe de revisar o postagem anterior primeiro. A última seção do post lista links para outros blogs de consulta relevantes.

Você pode fazer o download das compilações de pré-lançamento do Couchbase Mobile 2.0 em nosso downloads página.

Histórico

Se você estava usando as versões 1.x do Couchbase Mobile, provavelmente está familiarizado com Visualizações de mapas para criar índices e consultas. Na versão 2.0, você não precisa mais criar visualizações e funções de mapa! Em vez disso, uma interface simples permite a criação de índices e você pode usar uma interface do Query Builder para construir suas consultas. A nova interface de consulta é mais simples de usar e muito mais poderosa em comparação. Vamos descobrir alguns de seus recursos nesta postagem.

Projeto de amostra

Embora os exemplos discutidos aqui usem o Swift para iOS, observe que, salvo algumas pequenas diferenças, a mesma interface de consulta também é compatível com as plataformas Android e Windows. Portanto, com alguns pequenos ajustes, você poderá reutilizar os exemplos de consulta desta publicação ao trabalhar com outras plataformas.

Siga as instruções abaixo se você estiver interessado em um projeto Swift de amostra

Clone o iOS Swift Playground do GitHub

$ git clone https://github.com/couchbaselabs/couchbase-lite-ios-api-playground

1	$ git clone https://github.com/couchbaselabs/couchbase-lite-ios-api-playground

Siga as instruções de instalação no manual correspondente LEIAME para criar e executar o playground.

Modelo de dados de amostra

Usaremos o banco de dados Travel Sample localizado aqui

O conjunto de dados de amostra inclui vários tipos de documentos, conforme identificado pelo tipo no documento. Vamos nos concentrar em documentos de tipo "hotel" . O modelo de documento JSON é mostrado abaixo. Para fins de brevidade, omitimos algumas das propriedades do modelo abaixo.

Especificamente, observe que o modelo inclui coleções aninhadas - public_likes e revisões. As consultas nas seções seguintes lidarão com essas coleções aninhadas.

 {
 "type": "hotel",
 "name": "Medway Youth Hostel",
 "address": "Capstone Road, ME7 3JE",
 "city": "Medway",
 "country": "United Kingdom",
 "description": "blah blah",
 "public_likes": [
 "Julius Tromp I",
 "Corrine Hilll"
 ],
 "reviews": [
 {
 "author": "Ozella Sipes",
 "content": "blah blah.",
 "date": "2013–06–22 18:33:50 +0300",
 "ratings": {
 "Cleanliness": 5,
 "Location": 4,
 "Overall": 4,
 "Rooms": 3,
 "Service": 5,
 "Value": 4
 }
 },
 {
 "author": "Jeremy Snapes",
 "content": "blah blah.",
 "date": "2013–05–05 18:33:50 +0300",
 "ratings": {
 "Cleanliness": 2,
 "Location": 2,
 "Overall": 4,
 "Rooms": 3,
 "Service": 5,
 "Value": 4
 }
 }
 ],
  "url":"http://www.yha.org.uk",
    "vacancy": true
    }

{

"tipo": "hotel",

"name" (nome): "Albergue da Juventude de Medway",

"endereço": "Capstone Road, ME7 3JE",

"cidade": "Medway",

"país": "Reino Unido",

"description" (descrição): "blah blah",

"public_likes": [

"Julius Tromp I",

"Corrine Hilll"

"avaliações": [

{

"autor": "Ozella Sipes",

"content" (conteúdo): "blah blah".,

"data": "2013-06-22 18:33:50 +0300",

"classificações": {

"Limpeza": 5,

"Localização": 4,

"Geral": 4,

"Quartos": 3,

"Serviço": 5,

"Valor": 4

}

{

"autor": "Jeremy Snapes",

"content" (conteúdo): "blah blah".,

"data": "2013-05-05 18:33:50 +0300",

"classificações": {

"Limpeza": 2,

"Localização": 2,

"Geral": 4,

"Quartos": 3,

"Serviço": 5,

"Valor": 4

}

"url":"http://www.yha.org.uk",

"vaga": verdadeiro

}

** Consulte o modelo acima para cada um dos exemplos de consulta abaixo. **

O identificador do banco de dados

Nas consultas abaixo, usaremos o Banco de dados API para abrir/criar o banco de dados CouchbaseLite.

 var options = DatabaseConfiguration()
 let db = try Database(name: kDBName, config: options)

1 2	var opções = DatabaseConfiguration() deixar db = tentar Banco de dados(nome: kDBName, configuração: opções)

Índices

Para acelerar as consultas de leitura, você pode criar índices nas propriedades que serão consultadas. A melhoria no desempenho seria significativa em grandes conjuntos de dados. Obviamente, esteja ciente de que haverá um aumento na necessidade de armazenamento para guardar os índices, e o desempenho das gravações também poderá ser afetado. Portanto, tenha cuidado ao criar muitos índices.

O exemplo a seguir cria um Índice de valor no tipo propriedade de um documento

 try db.createIndex(IndexBuilder.valueIndex(items: ValueIndexItem.property("type")),withName: "typeIndex")

1	tentar db.createIndex(IndexBuilder.valueIndex(itens: ValueIndexItem.propriedade("tipo")),withName: "typeIndex")

O exemplo a seguir cria um Índice de valor em tipo e nome propriedades de um documento

try db.createIndex(IndexBuilder.valueIndex(items: ValueIndexItem.property("type"),ValueIndexItem.property("name")),withName: "TypeNameIndex")

1	tentar db.createIndex(IndexBuilder.valueIndex(itens: ValueIndexItem.propriedade("tipo"),ValueIndexItem.propriedade("name" (nome))),withName: "TypeNameIndex")

Contenção de matrizes

A consulta abaixo busca o IDs, nomes e public_likes propriedades de documentos em que o public_likes propriedade de matriz em "hotel" tipo contém o valor de "Corrine Hilll". Para isso, o **ArrayFunction.contains** é usada na expressão da função public_likes matriz.

let searchQuery = QueryBuilde.select(SelectResult.expression(Meta.id),
                  SelectResult.expression(Expression.property("name")),
                  SelectResult.expression(Expression.property("public_likes")))
 .from(DataSource.database(db))
 .where(Expression.property("type").equalTo(Expression.string("hotel"))
 .and( ArrayFunction.contains(Expression.property("public_likes"), value: Expression.string("Corrine Hilll"))))

deixar pesquisa = ConsultaBuilde.selecionar(SelecionarResultado.expressão(Meta.id),

SelecionarResultado.expressão(Expressão.propriedade("name" (nome))),

SelecionarResultado.expressão(Expressão.propriedade("public_likes")))

.de(Fonte de dados.banco de dados(db))

.onde(Expressão.propriedade("tipo").igual a(Expressão.string("hotel"))

.e( ArrayFunction.contém(Expressão.propriedade("public_likes"), valor: Expressão.string("Corrine Hilll"))))

Tamanho da matriz

A consulta abaixo busca o IDs, nomes e as propriedades tamanho de public_likes propriedade de matriz em "hotel" tipo documentos. Para isso, o **ArrayFunction.length** é usada na expressão da função public_likes para obter o tamanho da matriz.

Além disso, observe que estamos usando como expressão para pseudônimo o valor de contagem da matriz para NumLikes. Nós apresentamos aliases na postagem anterior do blog sobre Fundamentos da consulta. Se você não colocar um alias no resultado do arrayLength a chave da propriedade seria $1 o que não é muito intuitivo.

 let searchQuery = QueryBuilder.select(SelectResult.expression(Meta.id),
           SelectResult.expression(Expression.property("name")),
           SelectResult.expression(ArrayFunction.length(Expression.property("public_likes"))).as("NumLikes"))
 .from(DataSource.database(db))
 .where(Expression.property("type").equalTo(Expression.string("hotel")))
 .limit(Expression.int(limit))

deixar pesquisa = Criador de consultas.selecionar(SelecionarResultado.expressão(Meta.id),

SelecionarResultado.expressão(Expressão.propriedade("name" (nome))),

SelecionarResultado.expressão(ArrayFunction.comprimento(Expressão.propriedade("public_likes"))).como("NumLikes"))

.de(Fonte de dados.banco de dados(db))

.onde(Expressão.propriedade("tipo").igual a(Expressão.string("hotel")))

.limite(Expressão.int(limite))

Avaliação de membros da matriz

Enquanto o ArrayFunction.contains permite que você verifique se a matriz dada contém um valor específico, a expressão da função em pode ser usada para avaliar qualquer um ou todos os membros de uma matriz em relação a um critério especificado pela expressão de matriz satisfaz expressão. Esse é um recurso avançado de filtragem de documentos.

Oemé usada com a expressão qualquer, todos ou o anyAndEvery operadores quantificados em Expressão de matriz para avaliar qualquer, todo ou qualquer/todo elemento no objeto de matriz.

A consulta a seguir retorna os documentos em que qualquer dos valores no public_likes O array começa com os caracteres "Corr".

//1.
 let VAR_LIKEDBY = ArrayExpression.variable("likedby")
 
//2.
 let searchQuery = QueryBuilder.select(SelectResult.expression(Meta.id),
                  SelectResult.expression((Expression.property("public_likes"))))
.from(DataSource.database(db))
.where(Expression.property("type").equalTo(Expression.string("hotel"))
.and(ArrayExpression.any(VAR_LIKEDBY).in(Expression.property("public_likes"))
.satisfies(VAR_LIKEDBY.like(Expression.string("Cor%")))))
.limit(Expression.int(limit))<code>

//1.

deixar VAR_LIKEDBY = Expressão de matriz.variável("likedby")

//2.

deixar pesquisa = Criador de consultas.selecionar(SelecionarResultado.expressão(Meta.id),

SelecionarResultado.expressão((Expressão.propriedade("public_likes"))))

.de(Fonte de dados.banco de dados(db))

.onde(Expressão.propriedade("tipo").igual a(Expressão.string("hotel"))

.e(Expressão de matriz.qualquer(VAR_LIKEDBY).em(Expressão.propriedade("public_likes"))

.satisfaz(VAR_LIKEDBY.como(Expressão.string("Cor%")))))

.limite(Expressão.int(limite))<código>

1. Declare uma variável com o nome "likedby" para representar cada elemento no public_likes matriz
2. O qualquer ArrayExpression verifica se o elemento da matriz representado pelo apreciado por satisfaz os critérios da variável como expressão. A como verifica se o valor do item representado pela variável "likedby" começa com "Cor".

Matrizes de indexação

Você também pode consultar elementos em índices específicos. A consulta a seguir retorna o nome e primeiro membro da public_likes propriedades de matriz de todos os documentos "hotel

 let searchQuery = QueryBuilder.select(SelectResult.expression(Meta.id),
           SelectResult.expression(Expression.property("name")),
           SelectResult.expression(Expression.property("public_likes[0]")))
 .from(DataSource.database(db))
 .where(Expression.property("type").equalTo(Expression.string("hotel")))
 .limit(Expression.int(limit))

deixar pesquisa = Criador de consultas.selecionar(SelecionarResultado.expressão(Meta.id),

SelecionarResultado.expressão(Expressão.propriedade("name" (nome))),

SelecionarResultado.expressão(Expressão.propriedade("public_likes[0]")))

.de(Fonte de dados.banco de dados(db))

.onde(Expressão.propriedade("tipo").igual a(Expressão.string("hotel")))

.limite(Expressão.int(limite))

Avaliação de matrizes aninhadas

Você pode avaliar os membros de uma matriz aninhada. Para isso, você pode aplicar um caminho das teclas para a expressão da variável. A matriz aninhada deve ter um nível de profundidade.

A consulta a seguir retorna os documentos em que qualquer dos valores na tabela aninhada classificações tem a matriz Geral classificação de propriedade maior ou igual a 4.
Como você deve ter notado no modelo de dados acima, a propriedade "reviews" contém uma matriz de objetos. Cada um dos objetos contém um objeto classificações que, por sua vez, contém o array Geral propriedade.

// 1.
 let VAR_OVERALL = ArrayExpression.variable("review.ratings.Overall")
 //2.
 let VAR_REVIEWS = ArrayExpression.variable("review")
 //3.
 let searchQuery = QueryBuilder.select(SelectResult.expression(Meta.id),
          SelectResult.expression(Expression.property("name")))
 .from(DataSource.database(db))
 .where(Expression.property("type").equalTo(Expression.string("hotel"))
 .and(ArrayExpression.any(VAR_REVIEWS).in(Expression.property("reviews"))
 .satisfies(VAR_OVERALL.greaterThanOrEqualTo(Expression.int(4)))))
 .limit(Expression.int(limit))

// 1.

deixar VAR_OVERALL = Expressão de matriz.variável("review.ratings.Overall")

//2.

deixar VAR_REVIEWS = Expressão de matriz.variável("revisão")

//3.

deixar pesquisa = Criador de consultas.selecionar(SelecionarResultado.expressão(Meta.id),

SelecionarResultado.expressão(Expressão.propriedade("name" (nome))))

.de(Fonte de dados.banco de dados(db))

.onde(Expressão.propriedade("tipo").igual a(Expressão.string("hotel"))

.e(Expressão de matriz.qualquer(VAR_REVIEWS).em(Expressão.propriedade("avaliações"))

.satisfaz(VAR_OVERALL.greaterThanOrEqualTo(Expressão.int(4)))))

.limite(Expressão.int(limite))

Declare uma variável para representar um elemento no revisão.classificações.geral matriz
Declare uma variável para representar cada elemento no revisões matriz
O qualquer verifica se o elemento da matriz representado pela expressão revisão satisfaz os critérios da variável comparação expressão. A comparação verifica o valor de Geral propriedade do classificações no objeto representado pela variável "review" é maior ou igual a 4.

Limitações

Os recursos de manipulação de matriz não são tão extensos quanto os do N1QL conjunto de recursos. Mas é um bom ponto de partida. Esses recursos poderão estar disponíveis em versões futuras do Couchbase Mobile.

Portanto, por enquanto, cabe ao aplicativo manipular os resultados da matriz usando os recursos de processamento de coleção da linguagem.

Vamos considerar este exemplo em swift

Com relação ao modelo de dados, digamos que você queira determinar o mínimo Limpeza classificação para um determinado hotel com base nas avaliações sobre o hotel.

Com base no modelo acima, observe que o Limpeza é um membro da propriedade classificações contida em cada objeto que é membro de revisões matriz.

Para isso, você pode fazer uma consulta do Couchbase Lite para buscar o revisões propriedade de matriz para um hotel com Id especificado da seguinte forma -

 // 1. Query for reviews property array for the given hotel
 let searchQuery = QueryBuilder.select( 
        SelectResult.expression(Expression.property("reviews")))
 .from(DataSource.database(db))
 .where(Expression.property("type").equalTo(Expression.string("hotel"))
 .and(Meta.id.equalTo(Expression.string("hotel_10025"))))

// 1. consulta ao conjunto de propriedades de avaliações para o hotel fornecido

deixar pesquisa = Criador de consultas.selecionar(

SelecionarResultado.expressão(Expressão.propriedade("avaliações")))

.de(Fonte de dados.banco de dados(db))

.onde(Expressão.propriedade("tipo").igual a(Expressão.string("hotel"))

.e(Meta.id.igual a(Expressão.string("hotel_10025"))))

O resultSet A resposta à consulta acima seria uma matriz com um único elemento. Esse elemento corresponderia ao documento "hotel" para o Id especificado.

[
 {
 "reviews": [
 {
 "author": "Ozella Sipes",
 "content": "blah",
 "date": "2013–06–22 18:33:50 +0300",
 "ratings": {
 "Cleanliness": 5,
 "Location": 4,
 "Overall": 4,
 "Rooms": 3,
 "Service": 5,
 "Value": 4
 }
 },
 {
 "author": "fuzzy Snipes",
 "content": "blah",
 "date": "2013–06–22 18:33:50 +0300",
 "ratings": {
 "Cleanliness": 2,
 "Location": 3,
 "Overall": 4,
 "Rooms": 3,
 "Service": 5,
 "Value": 4
 }
 }
 ]
 }
]

[

{

"avaliações": [

{

"autor": "Ozella Sipes",

"content" (conteúdo): "blah",

"data": "2013-06-22 18:33:50 +0300",

"classificações": {

"Limpeza": 5,

"Localização": 4,

"Geral": 4,

"Quartos": 3,

"Serviço": 5,

"Valor": 4

}

{

"autor": "fuzzy Snipes",

"content" (conteúdo): "blah",

"data": "2013-06-22 18:33:50 +0300",

"classificações": {

"Limpeza": 2,

"Localização": 3,

"Geral": 4,

"Quartos": 3,

"Serviço": 5,

"Valor": 4

}

]

}

]

Agora, o aplicativo precisa implementar a lógica para iterar sobre o revisões e para cada membro da matriz, para buscar o classificações e a propriedade Limpeza valor.

Aqui está uma maneira possível de fazer isso no swift.

Primeiro, itere sobre o resultSet e extraia o valor da propriedade "reviews".

 var matches:[[String:Any]] = [[String:Any]]()
 do {
       for row in try searchQuery.execute() {
          if let reviewData = row.array(forKey: "reviews")?.toArray() as? [[String:Any]] {
          matches.append(reviewData)
      }
    }
 }

var jogos:[[Cordas:Qualquer]] = [[Cordas:Qualquer]]()

fazer {

para fila em tentar pesquisa.executar() {

se deixar reviewData = fila.matriz(forKey: "avaliações")?.toArray() como? [[Cordas:Qualquer]] {

jogos.anexar(reviewData)

}

Após o processamento do loop, a matriz "matches" seria algo parecido com o que está abaixo. Seria uma matriz contendo a matriz aninhada correspondente às revisões -

[
 [
 {
 "author": "Ozella Sipes",
 "content": "blah",
 "date": "2013–06–22 18:33:50 +0300",
 "ratings": {
 "Cleanliness": 5,
 "Location": 4,
 "Overall": 4,
 "Rooms": 3,
 "Service": 5,
 "Value": 4
 }
 },
 {
 "author": "fuzzy Snipes",
 "content": "blah",
 "date": "2013–06–22 18:33:50 +0300",
 "ratings": {
 "Cleanliness": 2,
 "Location": 3,
 "Overall": 4,
 "Rooms": 3,
 "Service": 5,
 "Value": 4
 }
 }
 ]
]

[

{

"autor": "Ozella Sipes",

"content" (conteúdo): "blah",

"data": "2013-06-22 18:33:50 +0300",

"classificações": {

"Limpeza": 5,

"Localização": 4,

"Geral": 4,

"Quartos": 3,

"Serviço": 5,

"Valor": 4

}

{

"autor": "fuzzy Snipes",

"content" (conteúdo): "blah",

"data": "2013-06-22 18:33:50 +0300",

"classificações": {

"Limpeza": 2,

"Localização": 3,

"Geral": 4,

"Quartos": 3,

"Serviço": 5,

"Valor": 4

}

]

Em seguida, você pode usar os recursos da linguagem swift, como flatMap e mapa para processar a matriz resultante e obter a classificação mínima de "Limpeza" para um determinado hotel

let minCleanlinessValue = matches.flatMap{$0}
 .map{return ($0["ratings"] as? [String:Any])?["Cleanliness"] as? Int}
 .flatMap{$0}
 .min { (a, b) -> Bool in
      return a < b
 }

deixar minCleanlinessValue (valor mínimo de limpeza) = jogos.flatMap{$0}

.mapa{retorno ($0["classificações"] como? [Cordas:Qualquer])?["Limpeza"] como? Int}

.flatMap{$0}

.min { (a, b) -> Bool em

retorno a < b

}

Você faria algo semelhante em linguagens que suportam construções funcionais como mapa plano e mapa.

O que vem a seguir

Esta postagem do blog analisou como você pode manipular os tipos de coleção Array usando a nova API de consulta no Couchbase Mobile 2.0. Isso é um começo. Espere ver mais funcionalidades em versões futuras. Você pode fazer o download da versão de pré-lançamento em nosso downloads página.

Aqui estão outras postagens relacionadas ao Couchbase Mobile Query que podem ser de interesse
- Isso postagem no blog discute os fundamentos da API de consulta
- Isso postagem no blog discute os recursos de pesquisa de texto completo.
- Isso postagem no blog discute como fazer consultas JOIN

Se tiver dúvidas ou comentários, deixe um comentário abaixo ou entre em contato comigo pelo Twitter @rajagp ou envie-me um e-mail priya.rajagopal@couchbase.com. O Fóruns do Couchbase são outro bom lugar para entrar em contato com perguntas.

Priya Rajagopal, Diretora Sênior, Gerenciamento de Produtos

Compartilhe este artigo

Platform

Self-Managed

Services

Capabilities

Why Couchbase?

Migrate to Capella

By Use Case

By Industry

By Application Need

Popular Docs

By Developer Role

Quickstart

Resource Center

About

Partnerships

Our Services

Partners: Register a Deal

Ready to register a deal with Couchbase?

Marriott

Como consultar coleções de matrizes no Couchbase Lite

Histórico

Projeto de amostra

Modelo de dados de amostra

O identificador do banco de dados

Índices

Contenção de matrizes

Tamanho da matriz

Avaliação de membros da matriz

Matrizes de indexação

Avaliação de matrizes aninhadas

Limitações

O que vem a seguir

Receba atualizações do blog do Couchbase em sua caixa de entrada

Autor

Postado por Priya Rajagopal, Diretora Sênior, Gerenciamento de Produtos

Deixe um comentário Cancelar resposta

Pronto para começar a usar o Couchbase Capella?

Iniciar a construção

Use o Capella gratuitamente

Entre em contato