Pagination in Couchbase Server with N1QL and PHP

Onwuka Gideon é um desenvolvedor freelancer de pilha completa com anos de experiência em projetar e codificar aplicativos da Web e resolver problemas complexos. Ele adora segurança, escrever e discutir novas tecnologias.

Ao criar aplicativos que lidam com um grande número de documentos, é importante usar a paginação para obter linhas por página.

Neste artigo, demonstrarei como implementar a paginação ao trabalhar com N1QL e PHP.

Um pouco sobre o N1QL

O Couchbase N1QL é uma linguagem de consulta declarativa que estende o SQL para JSON. Você pode consultar dados por meio da integração nativa da estrutura e da linguagem, de uma API fluente ou dos drivers JDBC/ODBC. O N1QL oferece aos desenvolvedores uma linguagem expressiva, poderosa e completa para consulta e manipulação de dados.

Pré-requisitos

Conhecimento básico do Couchbase e sua configuração em seu servidor (Instalação do Couchbase)
Conhecimento básico de N1QL
Conhecimento básico de PHP (opcional, pois qualquer linguagem pode ser usada)
Um SDK do Couchbase disponível (Acesse aqui)

O que construiríamos

Para os fins deste artigo, configuraremos rapidamente um ambiente PHP no qual basicamente extrairemos dados do banco de dados, paginaremos os dados e os exibiremos.

Configuração do ambiente

Etapa 1: criar um novo bucket

Faça login na área de administração do Couchbase e crie um novo nome de bucket comentários.

Etapa 2: criar um índice para o novo bucket: comentários

Clique na guia de consulta, insira a consulta listada abaixo e clique em executar.

create primary index on `commenting` using gsi;

1	criar primário índice em `comentários` usando gsi;

Se tudo correr bem, podemos começar a criar documentos.

Etapa 3: clonar o arquivo inicial do projeto

Criei a estrutura básica dos arquivos que usaremos neste tutorial.

Abra sua linha de comando e clone o repositório do github.

$ git clone git@github.com:dongido001/php-couchbase-pagination_complete.git

1	$ git clone git@github.com:dongido001/php-couchbase-pagination_complete.git

Agora, abra o arquivo que acabou de clonar em seu navegador. Você deverá ver a seguinte página:

A estrutura do arquivo

O repositório que você acabou de clonar contém 3 arquivos PHP: config.php, db.phpe index.php.

O config.php é onde definimos as informações do nosso banco de dados:

<?php
//some configs
define("C_USERNAMAE", "Administrator");
define("C_PASSWORD", "password");
define("C_URL", "http://127.0.0.1:8091/"); //eg: localhost:8091
define("DEFAULT_BUCKET", "commenting");

<?php

/algumas configurações

definir("C_USERNAMAE", "Administrador");

definir("C_PASSWORD", "senha");

definir("C_URL", "http://127.0.0.1:8091/"); //eg: localhost:8091

definir("DEFAULT_BUCKET", "comentando");

No db.phpEm seguida, nos conectamos ao Couchbase e abrimos um bucket. Você deve alterar os detalhes para que correspondam às informações do Couchbase.

<?php

$authenticator = new \Couchbase\ClassicAuthenticator();
$authenticator->cluster(C_USERNAMAE, C_PASSWORD);

$cluster = new \Couchbase\Cluster(C_URL);

$cluster->authenticate($authenticator);

$bucket = $cluster->openBucket(DEFAULT_BUCKET);

In the `index.php`, we have some PHP code at the top of the file and at the bottom, we also

<?php

$autenticador = novo \Couchbase\ClassicAuthenticator();

$autenticador->agrupamento(C_USERNAMAE, C_PASSWORD);

$agrupamento = novo \Couchbase\Aglomerado(C_URL);

$agrupamento->autenticar($autenticador);

$balde = $agrupamento->openBucket(DEFAULT_BUCKET);

Em o `índice.php`, nós ter alguns PHP código em o superior de o arquivo e em o fundo, nós também

tem algum código HTML.

//index.php

<?php

//include config details

require_once('config.php');

//include connection to the database.

require_once('db.php');

if( $_SERVER['REQUEST_METHOD'] == "POST"){

$uid = uniqid();

$comment = [

"_id"        => $uid,
"name"       => $_POST["name"],
"comment"    => $_POST["comment"],
"created_at" => date("Y-m-d H:i:s")
];

$bucket->insert($uid, $comment);

}

?>

...

//index.php

<?php

//incluir detalhes de configuração

require_once('config.php');

//incluir conexão com o banco de dados.

require_once('db.php');

se( $_SERVER['REQUEST_METHOD'] == "POST"){

$uid = uniqid();

$comentário = [

"_id" => $uid,

"name" (nome) => $_POST["name" (nome)],

"comentário" => $_POST["comentário"],

"created_at" => data("Y-m-d H:i:s")

];

$bucket->inserir($uid, $comentário);

}

...

Incluí os dois arquivos, config.php e db.php Em seguida, escrevi uma lógica para inserir alguns comentários no banco de dados quando o formulário é enviado.

//index.php

...

<!DOCTYPE html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous">
</head>
<body>

<div class="container">

<div class="container" style="margin-left: auto; margin-right: auto; width: 400px;">
<h4 class="text-center">Add a comment</h4>

<form action="" method="POST">
<div class="form-group">
<label for="name">Name:</label>
<input type="text" class="form-control" name="name" required>
</div>

<div class="form-group">
<label for="comment">Comment:</label>
<textarea class="form-control" rows="5" name="comment" required> </textarea>
</div>

<button type="submit" class="btn btn-primary">Submit</button>
</form> <br />

<div >
<h4 class="text-center">Listing comments</h4>

</div>

<div id="pagination">

</div>

</div>

</div>

</body>
</html>

//index.php

...

<!DOCTYPE html>

<cabeça>

</cabeça>

<corpo>

<h4 classe="text-center">Adicionar a comentário</h4>

<formulário ação="" método="POST">

<rótulo para="name" (nome)>Nome:</rótulo>

</div>

<rótulo para="comentário">Comentário:</rótulo>

<área de texto classe="form-control" (controle de formulário) linhas="5" nome="comentário" necessário> </área de texto>

</div>

<botão tipo="submit" (enviar) classe="btn btn-primary">Enviar</botão>

</formulário> <br />

<div >

<h4 classe="text-center">Listagem comentários</h4>

</div>

</div>

</corpo>

</html>

O código HTML exibe um formulário para adicionar e listar comentários.

Agora vamos começar!

Adicione quantos comentários da página você quiser. Em breve, estaremos paginando esses dados.

Buscar conteúdo paginado no banco de dados

Adicione o seguinte à parte do cabeçalho de index.php que está abaixo de cada código PHP na parte superior.

&nbsp;//Select all contentin our query 

$no_per_page = 4; //This is the number of Items we want per page

&nbsp;$current_page = (isset($_GET['page_id'])) ? $_GET['page_id'] : 1; //Gets the current page, if not set, default to page 1

$skip = ($current_page - 1) * $no_per_page; //Gets the total number of page we want to skip when making request. When we are on page one, We don't need to skip any Item.

$query = \Couchbase\N1qlQuery::fromString("SELECT * FROM `commenting` &nbsp;LIMIT $no_per_page OFFSET $skip");

$result = $bucket->query($query);

//count total number of result in the database

$total = $bucket->query(\Couchbase\N1qlQuery::fromString("SELECT COUNT(comment) total FROM `commenting`"));

$total = $total->rows[0]->total;

$number_of_pages = ceil( $total/$no_per_page ); //calculate number of pages

 /Selecionar todo o conteúdo em nossa consulta

$no_per_page = 4; /Esse é o número de itens que queremos por página

 $página_atual = (isset($_GET['page_id'])) ? $_GET['page_id'] : 1; /Obtém a página atual; se não for definida, o padrão é a página 1

$pular = ($página_atual - 1) * $no_per_page; /Obtém o número total de páginas que queremos ignorar ao fazer a solicitação. Quando estivermos na primeira página, não precisaremos pular nenhum item.

$consulta = \Couchbase\N1qlQuery::fromString("SELECT * FROM `commenting` LIMIT $no_per_page OFFSET $skip");

$resultado = $balde->consulta($consulta);

//contagem do número total de resultados no banco de dados

$total = $balde->consulta(\Couchbase\N1qlQuery::fromString("SELECT COUNT(comment) total FROM `commenting`"));

$total = $total->linhas[0]->total;

$número_de_páginas = teto( $total/$no_per_página ); //calcular o número de páginas

Acrescentei comentários ao código acima, que descrevem o que cada um faz. Aqui também usamos LIMITE E DESLOCAMENTO que nos permitiu LIMITAR o número de resultados que cada consulta deve retornar. O OFFSET foi usado para pular uma quantidade de dados durante a consulta, dependendo do número da página que estamos acessando no momento.

LIMITE: A cláusula LIMIT especifica o número máximo de objetos que podem ser retornados em um conjunto de resultados pelo SELECT. Um valor negativo ou um valor maior que 9223372036854775295 (resultado de 1 - 512) é considerado como LIMIT 0.

DESLOCAMENTO: A cláusula OFFSET especifica um número de objetos a serem ignorados. Se uma cláusula LIMIT também estiver presente, o OFFSET será aplicado antes do LIMIT. O valor OFFSET deve ser um número inteiro não negativo.

Preencher o resultado da consulta na página

Adicione o código abaixo a index.php dentro dessa tag, imediatamente após <h4 class="text-center">Listagem de comentários</h4> .

      <?php foreach( $result->rows as $comment ):?>
<div>
<div class="alert alert-success" role="alert">
<h5 class="alert-heading"> By: <?=$comment->commenting->name?>, Created At: <?=$comment->commenting->created_at?> </h5><br>
<p> <?=$comment->commenting->comment?></p>
<hr>
</div>

</div>
<?php endforeach; ?>

<?php antes de( $resultado->linhas como $comentário ):?>

<div>

<h5 classe="alert-heading" (cabeçalho de alerta)> Por: <?=$comentário->comentários->nome?>, Criado Em: <?=$comentário->comentários->created_at?> </h5><br>

<p> <?=$comentário->comentários->comentário?></p>

<hr>

</div>

<?php endforeach; ?>

Adicionar o link paginado

Adicione o código abaixo entre essa tag html <div id="pagination"> </div> na parte inferior do index.php.

    <nav aria-label="Page navigation example">
<ul class="pagination">
<?php for($i = 1; $i <= $number_of_pages; $i++): ?>
<li class="page-item"><a class="page-link" href="?page_id=<?=$i?>"><?=$i?></a></li>
<?php endfor; ?>
</ul>
</nav>

<navegação aria-rótulo="Exemplo de navegação de página">

<?php para($i = 1; $i <= $número_de_páginas; $i++): ?>

<?php para; ?>

</ul>

</navegação>

Aqui, estamos apenas imprimindo o número de páginas para a página.

Sim! Nossa paginação está funcionando agora.

Conclusão

Neste artigo, você aprendeu como implementar a paginação usando o N1QL. Também revisamos DESLOCAMENTO e LIMITE e como basicamente executar consultas no Couchbase usando o N1QL. Você pode obter o aplicativo completo aqui: (git@github.com:dongido001/php-couchbase-pagination_complete.git)

Obrigado pela leitura. Diga-me o que você achou ou se tiver alguma dúvida.

Esta postagem faz parte do Programa de Redação da Comunidade Couchbase

Laura Czajkowski, gerente da comunidade de desenvolvedores, Couchbase

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

Paginação no Couchbase Server com N1QL e PHP

Um pouco sobre o N1QL

Pré-requisitos

O que construiríamos

A estrutura do arquivo

Conclusão

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

Autor

Postado por Laura Czajkowski, gerente da comunidade de desenvolvedores, Couchbase

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