{"id":12874,"date":"2022-03-14T10:23:48","date_gmt":"2022-03-14T17:23:48","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=12874"},"modified":"2025-06-13T19:26:33","modified_gmt":"2025-06-14T02:26:33","slug":"reuse-sql-queries-between-server-mobile-app-databases","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/pt\/reuse-sql-queries-between-server-mobile-app-databases\/","title":{"rendered":"Reutilizar consultas SQL entre os bancos de dados do servidor e do aplicativo m\u00f3vel"},"content":{"rendered":"

Como todos sabemos, a manuten\u00e7\u00e3o do c\u00f3digo \u00e9 cara - quanto mais complexo for o c\u00f3digo, maior ser\u00e1 o custo de sua manuten\u00e7\u00e3o. Portanto, desde o in\u00edcio dos tempos, os desenvolvedores de software t\u00eam se esfor\u00e7ado muito para atingir o objetivo de <\/span>reutiliza\u00e7\u00e3o de c\u00f3digo<\/b>.<\/span><\/p>\n

O Couchbase Mobile 3.0 introduziu o suporte para consultas SQL++. Como desenvolvedor, a primeira coisa que me veio \u00e0 mente foi compartilhar as consultas usadas em projetos voltados para os aplicativos Couchbase Server e Couchbase Mobile.\u00a0<\/span><\/p>\n

Essa \u00e9 uma boa ideia? Vamos explorar essa quest\u00e3o usando dados de amostra e um aplicativo m\u00f3vel de prova de conceito.<\/span><\/p>\n

Dados de amostra<\/span><\/h4>\n

Todo o c\u00f3digo deste artigo est\u00e1 dispon\u00edvel em <\/span>GitHub<\/span><\/a>. Veja o <\/span>LEIAME<\/span><\/i><\/a> para obter informa\u00e7\u00f5es sobre como configurar os projetos em seu computador.<\/span><\/p>\n

Os dados de amostra s\u00e3o provenientes do <\/span>OpenStreetMap<\/span><\/a> e est\u00e1 licenciado sob a licen\u00e7a <\/span>Open Data Commons Licen\u00e7a de banco de dados aberto (ODbL)<\/span><\/a> pela OpenStreetMap Foundation.<\/span><\/p>\n

O conjunto de dados cont\u00e9m todas as lojas que vendem sorvete nos Estados Unidos. Um exemplo de documento JSON est\u00e1 listado abaixo:<\/span><\/p>\n

{\r\n \"type\": \"Feature\",\r\n \"id\": \"node\/472242349\",\r\n \"properties\": {\r\n \"addrCity\": \"Austin\",\r\n \"addrHousenumber\": \"4477\",\r\n \"addrPostcode\": \"78745\",\r\n \"addrState\": \"TX\",\r\n \"addrStreet\": \"South Lamar Boulevard\",\r\n \"addrUnit\": \"#790\",\r\n \"amenity\": \"ice_cream\",\r\n \"cuisine\": \"ice_cream\",\r\n \"name\": \"Amy's Ice Creams\",\r\n \"phone\": \"+1-512-891-0573\",\r\n \"id\": \"node\/472242349\"\r\n},\r\n  \"geometry\": {\r\n   \"type\": \"Point\",\r\n   \"coordinates\": [\r\n    -97.7998856,\r\n    30.230688\r\n  ]\r\n }\r\n}<\/pre>\n
Como voc\u00ea pode ver, esse \u00e9 um conjunto de dados vers\u00e1til para testes porque tem propriedades incorporadas nos documentos.<\/span><\/p>\n
Exemplo de aplicativo m\u00f3vel<\/span><\/h4>\n
O Exemplo de aplicativo m\u00f3vel<\/a> foi escrito em <\/span>SwiftUI<\/span><\/a> com <\/span>Combinar<\/span><\/a> e \u00e9 um aplicativo para iOS\/macOS que exibe todas as v\u00e1rias lojas que vendem sorvete nos Estados Unidos. O aplicativo inclui um <\/span>banco de dados pr\u00e9-criado<\/span><\/a> com os mesmos documentos JSON j\u00e1 importados para ele por conveni\u00eancia. Esse aplicativo m\u00f3vel usa a vers\u00e3o mais recente do <\/span>SDK do Couchbase Lite<\/span><\/a>. Voc\u00ea pode abrir o projeto no XCode a partir do arquivo de projeto na pasta src para acompanhar o processo.<\/span><\/p>\n
Uma compara\u00e7\u00e3o de consulta simples<\/span><\/h4>\n
Para iniciar nossos testes, podemos escrever uma consulta simples para o Couchbase Server, para mostrar todos os endere\u00e7os de sorveterias e orden\u00e1-los pelo nome da loja:<\/span><\/p>\n
SELECT id, properties.addrCity, properties.addrHousenumber, properties.addrPostcode, \r\nproperties.addrStreet, properties.addrState, properties.name \r\nFROM icecream \r\nWHERE properties.addrCity <> \"\" \r\nAND type = \"Feature\" \r\nORDER BY properties.name<\/pre>\n
Essa consulta tem um filtro que retorna apenas documentos em que o objeto da propriedade <\/span>addrCity <\/span><\/i>tem um valor e onde o documento <\/span>tipo<\/span><\/i> \u00e9 igual a <\/span>Recurso<\/span><\/i>. Se voc\u00ea se pergunta por que temos o <\/span>addrCity<\/span><\/i> \u00e9 devido a dados sujos ou documentos sem nomes ou informa\u00e7\u00f5es ausentes nesse conjunto de dados. Usando um <\/span>tipo<\/span><\/i> O atributo \u00e9 comum em aplicativos m\u00f3veis para filtrar diferentes tipos de documentos.<\/span><\/p>\n
Podemos usar o <\/span>Editor de consultas<\/b> do servidor Couchbase<\/span> Console da Web<\/b><\/a> para executar essa consulta. Quando a executei em meu Macbook Pro M1 Max pessoal, o resultado chegou em 38,4 ms. Essa consulta usa o <\/span>adv_properties_addrCity_type<\/span><\/i> que voc\u00ea pode ver clicando no \u00edcone <\/span>Consultor de \u00edndices<\/b> bot\u00e3o.<\/span><\/p>\n
Portando a consulta para o Couchbase Lite<\/span><\/h4>\n
Agora vamos ver essa mesma consulta em execu\u00e7\u00e3o no nosso aplicativo m\u00f3vel. Para visualizar o aplicativo m\u00f3vel, voc\u00ea pode usar o XCode para abrir o arquivo <\/span>IceCreamLocator.xcodeproj<\/span><\/i> localizado no arquivo <\/span>src <\/span><\/i>pasta. Uma vez aberta no Xcode, localize a pasta <\/span>IceCreamLocationRepository<\/span><\/i><\/a> swift no arquivo <\/span>Compartilhado\\Data<\/span><\/i> pasta.\u00a0<\/span><\/p>\n
O <\/span>inicial <\/span><\/i>ativa o registro detalhado do banco de dados para inspecionar as informa\u00e7\u00f5es da consulta. Usando o registro detalhado, voc\u00ea pode analisar o que est\u00e1 acontecendo no Couchbase Lite, incluindo o desempenho da consulta.<\/span><\/p>\n
Vamos analisar a consulta simples do Couchbase Server e ver como ela funciona no Swift com a nova API de consulta SQL++. A fun\u00e7\u00e3o para a consulta simples \u00e9 denominada <\/span>getListByTypeCityOrderName<\/span><\/i><\/a>e o c\u00f3digo \u00e9 exibido abaixo:<\/span><\/p>\n
  func getListByTypeCityOrderName() -> Void {\r\n      do {\r\n        if let query = try _db?.createQuery(\"SELECT id, \r\nproperties.addrCity, properties.addrHousenumber, properties.addrPostcode, properties.addrStreet, \r\nproperties.addrState, properties.name FROM _ WHERE properties.addrCity <> \\\"\\\" AND \r\ntype = \\\"Feature\\\" ORDER BY properties.name\") {\r\n            var results: [IceCreamLocation] = []\r\n            let explain = try query.explain()\r\n            print (\"**EXPLAIN** \\(explain)\")\r\n            for result in try query.execute() {\r\n                if let data = result.toJSON().data(using: .utf8){\r\n                   let location = try \r\nJSONDecoder().decode(IceCreamLocation.self, from: data)\r\n                   results.append(location)\r\n             }\r\n           }\r\n           self.iceCreamLocationList.send(results)\r\n           self.iceCreamLocationList.send(completion: .finished)\r\n         }\r\n     } catch {\r\n         print(\"**Error**: \\(error)\")\r\n         self.iceCreamLocationList.send(completion: .failure(DbError.unknown))\r\n     }\r\n}<\/pre>\n
H\u00e1 algumas maneiras de fazer uma consulta SQL++ no Swift. Neste exemplo, usamos o banco de dados <\/span>createQuery<\/span><\/i><\/a> para criar a consulta. No Couchbase Lite, estou usando o caractere de sublinhado (_) como o nome do banco de dados antes da fun\u00e7\u00e3o <\/span>DE <\/span><\/i>declara\u00e7\u00e3o. Alterar o nome do banco de dados \u00e9 uma das altera\u00e7\u00f5es esperadas para reutilizar instru\u00e7\u00f5es SQL++. Al\u00e9m disso, para escapar das aspas no comando <\/span>ONDE <\/span><\/i>tive que adicionar o caractere de escape de string do Swift (<\/span>\\<\/span><\/i>) antes de cada aspa.\u00a0<\/span><\/p>\n
Para testar essa consulta durante a execu\u00e7\u00e3o, voc\u00ea pode abrir o arquivo <\/span>IceCreamListViewModel<\/span><\/i><\/a> encontrado no arquivo <\/span>ViewModels <\/span><\/i>pasta. Localize a pasta <\/span>inicial <\/span><\/i>e descomente a primeira linha de exemplo localizada na parte inferior da fun\u00e7\u00e3o que chama a fun\u00e7\u00e3o <\/span>getListByTypeCityOrderName<\/span><\/i> da fun\u00e7\u00e3o <\/span>_reposit\u00f3rio <\/span><\/i>vari\u00e1vel:<\/span><\/p>\n
 \/\/first example\r\n_repository.getListByTypeCityOrderName()<\/pre>\n
Agora voc\u00ea pode usar o Xcode para executar o aplicativo em um simulador do iOS ou em um aplicativo do macOS. Em seguida, abra o aplicativo <\/span>Console de depura\u00e7\u00e3o <\/b>no Xcode, clicando no \u00edcone <\/span>Mostrar depura\u00e7\u00e3o <\/b>no canto inferior direito do editor do Xcode, conforme destacado abaixo.<\/span><\/p>\n
\"\"<\/p>\n
O registro detalhado exibir\u00e1 uma quantidade enorme de informa\u00e7\u00f5es de registro. Para ajudar a encontrar as informa\u00e7\u00f5es corretas nos logs, use a caixa de filtro abaixo do console. Por exemplo, digite o texto \"<\/span>Informa\u00e7\u00f5es de consulta<\/span><\/i>\" e, em seguida, pressione a tecla Enter em seu teclado para ver informa\u00e7\u00f5es sobre a consulta. O console de depura\u00e7\u00e3o filtrar\u00e1 os dados que o Couchbase Lite retorna.<\/span><\/p>\n
A inspe\u00e7\u00e3o dos registros mostrar\u00e1 a <\/span>Informa\u00e7\u00f5es de consulta<\/span><\/i> e o n\u00famero de documentos encontrados pela consulta, quantos bytes e quanto tempo a consulta levou. Lembre-se de que os n\u00fameros que voc\u00ea est\u00e1 vendo s\u00e3o de um simulador, n\u00e3o de um dispositivo real. Para ajustar o desempenho de aplicativos m\u00f3veis, voc\u00ea deve usar ferramentas da Apple com um dispositivo real.<\/span><\/p>\n
A velocidade de execu\u00e7\u00e3o dessa consulta \u00e9 impressionante. Ainda mais impressionante \u00e9 o fato de que ainda n\u00e3o foram criados \u00edndices, portanto, essa consulta \u00e9 executada sem um \u00edndice e faz uma varredura de tabela, o que significa que ela precisa examinar o banco de dados em cada documento para ver se ele corresponde aos requisitos da consulta. O Couchbase Lite n\u00e3o exige \u00edndices e far\u00e1 varreduras de tabela se necess\u00e1rio, enquanto o Couchbase Server exige \u00edndices porque as varreduras de tabela podem prejudicar o desempenho de todo o cluster.\u00a0<\/span><\/p>\n
Em v\u00e1rios casos, a adi\u00e7\u00e3o de \u00edndices pode melhorar significativamente o desempenho de suas consultas, portanto, vamos parar de executar o aplicativo, adicionar o \u00edndice adequado e verificar novamente o desempenho.<\/span><\/p>\n
Abra o <\/span>IceCreamLocationRepository<\/span><\/i> e localize o <\/span>createIceCreamIndexes<\/span><\/i><\/a> fun\u00e7\u00e3o. Descomente o primeiro bloco de c\u00f3digo para criar o primeiro \u00edndice de consulta:<\/span><\/p>\n
   let simpleIndex = ValueIndexConfiguration([\"properties.name\", \"properties.addrCity\", \"type\"])\r\n   try _db?.createIndex(simpleIndex, name: \"idx_location_type_city_name\")<\/pre>\n
Como testamos para ver se a consulta usou o \u00edndice que criamos? Na consulta <\/span>getListByTypeCityOrderName<\/span><\/i> voc\u00ea ver\u00e1 duas linhas que imprimem os resultados da fun\u00e7\u00e3o explain no console:<\/span><\/p>\n
let explain = try query.explain()\r\nprint (\"**EXPLAIN** \\(explain)\")<\/pre>\n
A consulta <\/span>explicar<\/span><\/a> executar\u00e1 o equivalente \u00e0 fun\u00e7\u00e3o SQLite <\/span>EXPLICAR O PLANO DE CONSULTA<\/span><\/i> e armazene os resultados em uma cadeia de caracteres que voc\u00ea envia ao console usando a fun\u00e7\u00e3o print. Voc\u00ea pode filtrar por <\/span>TABELA DE VARREDURA <\/span><\/i>no console de depura\u00e7\u00e3o para encontrar os resultados. Ao analisar os resultados, certifique-se de remover o filtro anterior da janela do console. Agora, execute novamente o aplicativo e examine os registros para verificar a altera\u00e7\u00e3o de desempenho.<\/span><\/p>\n
\"\"<\/p>\n
Voc\u00ea dever\u00e1 ver o <\/span>USANDO O \u00cdNDICE <\/span><\/i>com o nome do \u00edndice criado, o que informa que a consulta usa o \u00edndice adequado. Observe que, embora os \u00edndices possam ajudar as consultas, eles tamb\u00e9m podem tornar mais lentas as inser\u00e7\u00f5es e atualiza\u00e7\u00f5es de documentos. Voc\u00ea pode encontrar mais informa\u00e7\u00f5es sobre indexa\u00e7\u00e3o na se\u00e7\u00e3o Couchbase Lite <\/span>documenta\u00e7\u00e3o<\/span><\/a>.<\/span><\/p>\n
Outra compara\u00e7\u00e3o de consulta<\/span><\/h4>\n
Em nossa segunda compara\u00e7\u00e3o, filtramos os resultados para mostrar apenas as sorveterias no estado da Ge\u00f3rgia, ordenadas por cidade e estado:<\/span><\/p>\n
SELECT id, properties.addrCity, properties.addHousenumber, properties.addrPostcode, \r\nproperties.addrStreet, properties.addrState, properties.name \r\nFROM icecream \r\nWHERE\r\nproperties.addrCity IS NOT NULL \r\nAND properties.addrState = 'GA'\r\nAND type = \"Feature\" \r\nORDER BY properties.name<\/pre>\n
Essa consulta retorna 15 documentos e usa uma consulta diferente, pois usamos o <\/span>properties.addrState <\/span><\/i>e <\/span>properties.addrCity<\/span><\/i> em nossos atributos <\/span>ONDE <\/span><\/i>cl\u00e1usula.\u00a0<\/span><\/p>\n
Observe que mudamos a forma como verificamos o <\/span>properties.addrCity<\/span><\/i> e usar o atributo <\/span>IS NOT NULL<\/span><\/i> agora. Isso mostra a flexibilidade da linguagem SQL++ e como os desenvolvedores podem usar diferentes sintaxes para produzir os mesmos resultados.<\/span><\/p>\n
\"\"<\/p>\n
Agora, vamos voltar ao nosso aplicativo m\u00f3vel para observar as diferen\u00e7as. A fun\u00e7\u00e3o para nossa segunda consulta \u00e9 denominada <\/span>getListByStateGeorgia<\/span><\/i><\/a>e o c\u00f3digo \u00e9 exibido abaixo:<\/span><\/p>\n
    func getListByStateGeorgia() -> Void {\r\n        do {\r\n           if let query = try _db?.createQuery(\"SELECT id, properties.addrCity, \r\nproperties.addrHousenumber, properties.addrPostcode, properties.addrStreet, \r\nproperties.addrState, properties.name FROM _ WHERE properties.addrCity NOT NULL AND \r\nproperties.addrState = \\\"GA\\\" AND type=\\\"Feature\\\" ORDER BY properties.name\") {\r\n               var results: [IceCreamLocation] = []\r\n               let explain = try query.explain()\r\n               print (\"**EXPLAIN** \\(explain)\")\r\n               for result in try query.execute() {\r\n                   if let data = result.toJSON().data(using: .utf8){\r\n                      let location = try \r\nJSONDecoder().decode(IceCreamLocation.self, from: data)\r\n                      results.append(location)\r\n                 }\r\n              }\r\n              self.iceCreamLocationList.send(results)\r\n              self.iceCreamLocationList.send(completion: .finished)\r\n          }\r\n        } catch {\r\n            print(\"**Error**: \\(error)\")\r\n            self.iceCreamLocationList.send(completion: .failure(DbError.unknown))\r\n     }\r\n   }<\/pre>\n
Para testar essa nova consulta, voc\u00ea pode abrir o arquivo <\/span>IceCreamListViewModel<\/span><\/i>. Localize o <\/span>inicial<\/span><\/i><\/a> e comente a primeira linha de exemplo localizada na parte inferior da fun\u00e7\u00e3o que chama a fun\u00e7\u00e3o <\/span>getListByTypeCityOrderName <\/span><\/i>da fun\u00e7\u00e3o <\/span>_reposit\u00f3rio<\/span><\/i> e descomente a linha que chama nossa nova fun\u00e7\u00e3o:<\/span><\/p>\n
\/\/first example\r\n\/\/_repository.getListByTypeCityOrderName()\r\n\r\n\/\/second example\r\n_repository.getListByStateGeorgia()<\/pre>\n
Voc\u00ea pode depurar o aplicativo usando o Xcode e verificar a \u00e1rea de depura\u00e7\u00e3o. Ela mostra os mesmos 15 documentos que foram retornados pela consulta executada no Couchbase Server, mas voltamos a fazer uma varredura de tabela, o que n\u00e3o \u00e9 o comportamento que queremos - alteramos a consulta, mas ainda n\u00e3o criamos nenhum \u00edndice novo.<\/span><\/p>\n
\"\"<\/p>\n
Para corrigir isso, podemos voltar ao <\/span>IceCreamLocationRepository<\/span><\/i><\/a> e localize o <\/span>createIceCreamIndexes<\/span><\/i><\/a> fun\u00e7\u00e3o. Descomente o segundo bloco de c\u00f3digo para criar o segundo \u00edndice de consulta:<\/span><\/p>\n
        let secondIndex = \r\nValueIndexConfiguration([\"properties.name\",\"properties.addrCity\", \"type\", \"properties.addrState\"])\r\n        try _db?.createIndex(secondIndex, name: \"idx_location_type_city_state_name\")<\/pre>\n
\"\"<\/p>\n
Descobrimos que poder\u00edamos reutilizar o c\u00f3digo nessas duas consultas mais simples, mas tivemos que adicionar os \u00edndices para evitar varreduras de tabela.<\/span><\/p>\n
Capturas com reutiliza\u00e7\u00e3o de consultas<\/span><\/h4>\n
O Couchbase Server e o Couchbase Mobile n\u00e3o usam o mesmo mecanismo de armazenamento ou de consulta. Portanto, voc\u00ea pode se deparar com consultas do Couchbase Server que precisam de pequenas modifica\u00e7\u00f5es para serem otimizadas para o Couchbase Mobile.<\/span><\/p>\n
Para obter mais informa\u00e7\u00f5es sobre o Couchbase Server, consulte a documenta\u00e7\u00e3o sobre o <\/span>Otimizador baseado em custos<\/span><\/a> que o mecanismo de consulta usa. O portal do desenvolvedor do Couchbase tamb\u00e9m tem um bom artigo sobre como melhorar <\/span>desempenho da consulta<\/span><\/a> no Couchbase Server que podem explicar por que algumas consultas s\u00e3o escritas de uma maneira espec\u00edfica.\u00a0<\/span><\/p>\n
Recomendo a leitura da documenta\u00e7\u00e3o do Couchbase Mobile sobre solu\u00e7\u00e3o de problemas <\/span>consultas<\/span><\/a> pois ele me ajudou a escrever consultas otimizadas e explica melhor a sa\u00edda do plano de consulta do SQLite.<\/span><\/p>\n
Resumo<\/span><\/h4>\n
Conforme mostrado em nossos exemplos de c\u00f3digo com a vers\u00e3o 3.0 do Couchbase Mobile, \u00e9 poss\u00edvel reutilizar o c\u00f3digo SQL++ entre o Server e o Mobile. No entanto, talvez seja necess\u00e1rio modificar as consultas e os \u00edndices para obter o melhor desempenho. Por isso, recomendo fortemente a leitura da excelente documenta\u00e7\u00e3o sobre <\/span>SQL++ for Mobile - Diferen\u00e7as em rela\u00e7\u00e3o ao SQL++ for Server<\/span><\/a> e <\/span>Strings de consulta SQL++<\/span><\/a>. Ele cont\u00e9m informa\u00e7\u00f5es valiosas sobre as altera\u00e7\u00f5es que voc\u00ea pode precisar fazer em suas consultas para us\u00e1-las em seus aplicativos m\u00f3veis.<\/span><\/p>\n
Aqui est\u00e3o alguns dos principais recursos mencionados ao longo da postagem:<\/span><\/p>\n