Como usar o buffer adaptável

BaixarBaixar o driver JDBC

O buffer adaptável é criado para recuperar qualquer tipo de dados de valor grande sem a sobrecarga de cursores de servidor. Aplicativos podem usar o recurso de utilização de buffer adaptável com todas as versões do SQL Server compatíveis com o driver.

Normalmente, quando o Microsoft JDBC Driver para SQL Server executa uma consulta, o driver recupera todos os resultados do servidor na memória do aplicativo. Embora esta abordagem minimize o consumo de recursos no SQL Server, ela pode lançar um OutOfMemoryError no aplicativo de JDBC para as consultas que geram resultados muito grandes.

Para permitir que aplicativos administrem resultados muito grandes, o Microsoft JDBC Driver para SQL Server fornece um buffer adaptável. Com buffer adaptável, o driver recupera os resultados da execução da instrução do SQL Server à medida que o aplicativo precisa deles, em vez de todos de uma vez. O driver também descarta os resultados assim que o aplicativo já não os pode acessar. Veja a seguir alguns exemplos em que o buffer adaptável pode ser útil:

  • A consulta produz um conjunto de resultados muito grande: o aplicativo pode executar uma instrução SELECT que produz mais linhas do que o aplicativo pode armazenar na memória. Em versões anteriores, o aplicativo precisava usar um cursor de servidor para evitar um OutOfMemoryError. O buffer adaptável permite fazer uma passagem somente avanço somente leitura de um conjunto de resultados arbitrariamente grande sem exigir um cursor de servidor.

  • A consulta produz colunas SQLServerResultSet muito grandes ou valores de parâmetro SQLServerCallableStatement OUT: O aplicativo pode recuperar um valor único (coluna ou parâmetro OUT) que é muito grande para se encaixar totalmente na memória do aplicativo. O buffer adaptável permite que o aplicativo cliente recupere esse valor como um fluxo, usando os métodos getAsciiStream, getBinaryStream ou o getCharacterStream. O aplicativo recupera o valor do SQL Server à medida que o lê o fluxo.

Observação

Com buffer adaptável, o driver JDBC armazena em buffer somente a quantidade de dados necessária. O driver não fornece nenhum método público para controlar ou limitar o tamanho do buffer.

Definindo o buffer adaptável

Do driver JDBC versão 2.0 em diante, o comportamento padrão do driver é "adaptável". Em outras palavras, para obter o comportamento de buffer adaptável, o aplicativo não precisa solicitar o comportamento adaptável explicitamente. No entanto, na versão 1.2 o modo padrão de buffer era "full" e o aplicativo precisava solicitar explicitamente o modo de buffer adaptável.

Há três maneiras de um aplicativo solicitar que a execução de instrução use buffer adaptável:

Ao usar o JDBC Driver versão 1.2, os aplicativos precisaram converter o objeto de instrução para uma classe SQLServerStatement para usar o método setResponseBuffering. Os exemplos de código no Lendo exemplo de dados grandes e Lendo exemplo de dados grandes com procedimentos armazenados demonstram esse uso antigo.

Porém, com o driver JDBC versão 2.0, os aplicativos podem usar o método isWrapperFor e o método unwrap para acessar a funcionalidade específica do fornecedor sem qualquer pressuposição sobre a hierarquia de classe de implementação. Para ver um exemplo de código, confira o tópico Atualizar um exemplo de dados grandes.

Recuperando dados grandes com o buffer adaptável

Quando valores grandes são lidos uma vez usando os métodos get<Type>Stream e as colunas ResultSet e os parâmetros CallableStatement OUT são acessados na ordem retornada pelo SQL Server, o buffer adaptável minimiza o uso de memória do aplicativo ao processar os resultados. Ao usar buffer adaptável:

  • Os métodos get<Type>Stream definidos nas classes SQLServerResultSet e SQLServerCallableStatement retornam fluxos de leitura única por padrão, embora os fluxos possam ser reiniciados caso estejam marcados pelo aplicativo. Se o aplicativo desejar reset o fluxo, primeiro precisará chamar o método mark naquele fluxo.

  • Os métodos get<Type>Stream definidos nas classes SQLServerClob e SQLServerBlob retornam fluxos que sempre podem ser reposicionados para a posição de início do fluxo sem chamar o método mark.

Quando o aplicativo usar buffer adaptável, os valores recuperados pelos métodos get<Type>Stream somente poderão ser recuperados uma vez. Se você tentar chamar qualquer método get<Type> na mesma coluna ou parâmetro depois de chamar o método get<Type>Stream do mesmo objeto, uma exceção será lançada com a mensagem "Os dados foram acessados e não estão disponíveis para esta coluna ou parâmetro".

Observação

Uma chamada para ResultSet.close() no meio do processamento de um ResultSet exigiria que o Microsoft JDBC Driver para SQL Server lesse e descartasse todos os pacotes restantes. Isso poderá levar um tempo considerável se a consulta retornar um conjunto de dados grande e especialmente se a conexão de rede estiver lenta.

Diretrizes para usar o buffer adaptável

Os desenvolvedores devem seguir estas diretrizes importantes para minimizar o uso de memória pelo aplicativo:

  • Evite usar a propriedade da cadeia de conexão selectMethod=cursor para permitir que o aplicativo processe um conjunto de resultados muito grande. O recurso de buffer adaptável permite que os aplicativos processem conjuntos de resultados somente encaminhamento e somente leitura muito grandes sem usar um cursor de servidor. Observe que, quando você define selectMethod=cursor, todos os conjuntos de resultados somente avanço e somente leitura gerados por aquela conexão são afetados. Em outras palavras, se o aplicativo processar conjuntos de resultados curtos habitualmente com alguns linhas, criar, ler e fechar um cursor de servidor para cada conjunto de resultados usará mais recursos nos lados do cliente e do servidor do que seria o caso quando selectMethod não está definido como cursor.

  • Leia os valores de texto grande ou binários como fluxos usando os métodos getAsciiStream, getBinaryStream ou getCharacterStream em vez dos métodos getBlob ou getClob. Da versão 1.2 em diante, a classe SQLServerCallableStatement oferece novos métodos get<Type>Stream para esse propósito.

  • Verifique se as colunas com valores potencialmente grandes são colocadas por último na lista de colunas em uma instrução SELECT e se os métodos get<Type>Stream de SQLServerResultSet são usados para acessar as colunas na ordem em que são selecionadas.

  • Verifique se os parâmetros OUT com valores potencialmente grandes são declarados por último na lista de parâmetros no SQL usada para criar SQLServerCallableStatement. Além disso, verifique se os métodos get<Type>Stream de SQLServerCallableStatement são usados para acessar os parâmetros OUT na ordem em que eles são declarados.

  • Evite executar mais de uma instrução na mesma conexão simultaneamente. Executar outra instrução antes de processar os resultados da instrução anterior pode fazer os resultados não processados serem armazenados em buffer na memória do aplicativo.

  • Há alguns casos em que o uso de selectMethod=cursor em vez de responseBuffering=adaptive seria mais benéfico, como:

    • Se o aplicativo processar um conjunto de resultados somente avanço e somente leitura lentamente, como ler cada linha depois de alguma entrada do usuário, usar selectMethod=cursor em vez de responseBuffering=adaptive poderá ajudar a reduzir o uso de recurso pelo SQL Server.

    • Se o aplicativo processar dois ou mais conjuntos de resultados somente avanço e somente leitura ao mesmo tempo na mesma conexão, usar selectMethod=cursor em vez de responseBuffering=adaptive poderá ajudar a reduzir a memória exigida pelo driver para processar esses conjuntos de resultados.

    Em ambos os casos, você precisa considerar a sobrecarga de criar, ler e fechar os cursores de servidor.

Além disso, a lista a seguir fornece algumas recomendações para conjuntos de resultados roláveis e atualizáveis somente avanço:

  • Para conjuntos de resultados roláveis, ao buscar um bloco de linhas, o driver sempre lê na memória o número de linhas indicado pelo método getFetchSize do objeto SQLServerResultSet, até mesmo quando o buffer adaptável está habilitado. Se rolar causar um OutOfMemoryError, você poderá reduzir o número de linhas buscadas chamando o método setFetchSize do objeto SQLServerResultSet para definir o tamanho da busca como um número menor de linhas, até mesmo 1 linha, se necessário. Se isto não impedir um OutOfMemoryError, evite incluir colunas muito grandes em conjuntos de resultados roláveis.

  • Para conjuntos de resultados roláveis, ao buscar um bloco de linhas, o driver geralmente lê na memória o número de linhas indicado pelo método getFetchSize do objeto SQLServerResultSet, até mesmo quando o buffer adaptável está habilitado na conexão. Se chamar o método next do objeto SQLServerResultSet resultar em um OutOfMemoryError, você poderá reduzir o número de linhas buscadas chamando o método setFetchSize do objeto SQLServerResultSet para definir o tamanho da busca como um número menor de linhas, até mesmo 1 linha, se necessário. Você também pode forçar o driver a não armazenar em buffer nenhuma linha chamando o método setResponseBuffering do objeto SQLServerStatement com o parâmetro "adaptive" antes de executar a instrução. Como não é possível rolar pelo conjunto de resultados, se o aplicativo acessar um valor de coluna grande usando um dos métodos get<Type>Stream, o driver descartará o valor assim que ele for lido pelo aplicativo, da mesma maneira que faz com os conjuntos de resultados somente leitura e somente avanço.

Confira também

Melhorando o desempenho e a confiabilidade com o JDBC Driver