Share via

Converter código R em um procedimento armazenado usando sqlrutils

  • Artigo

Este artigo descreve as etapas para usar o pacote sqlrutils para converter seu código R para ser executado como um procedimento armazenado T-SQL. Para obter os melhores resultados possíveis, seu código poderá precisar ser um pouco modificado, para garantir que todas as entradas possam ser parametrizadas.

Etapa 1. Reescrever o script R

Para obter os melhores resultados, reescreva o código R para encapsulá-lo como uma única função.

Todas as variáveis usadas pela função devem ser definidas dentro da função ou definidas como parâmetros de entrada. Veja o código de exemplo neste artigo.

Além disso, como os parâmetros de entrada para a função R passarão a ser os parâmetros de entrada do procedimento armazenado do SQL, as entradas e saídas devem estar em conformidade com os seguintes requisitos de tipo:

Entradas

Entre os parâmetros de entrada pode haver no máximo um quadro de dados.

Os objetos dentro do quadro de dados, bem como todos os outros parâmetros de entrada da função, devem ser dos seguintes tipos de dados R:

  • POSIXct
  • numeric
  • character
  • inteiro
  • logical
  • raw

Se um tipo de entrada não é de um dos tipos acima, ele precisa ser serializado e transmitido para a função como raw. Nesse caso, a função também deve incluir o código para desserializar a entrada.

outputs

A função pode produzir uma das seguintes opções:

  • Um quadro de dados que contém os tipos de dados com suporte. Todos os objetos no quadro de dados devem usar um dos tipos de dados com suporte.
  • Uma lista nomeada, contendo no máximo um quadro de dados. Todos os membros da lista devem usar um dos tipos de dados com suporte.
  • Um valor NULO, se sua função não retornar nenhum resultado

Etapa 2. Gerar os objetos necessários

Depois que o código R estiver limpo e puder ser chamado como uma única função, você usará as funções no pacote sqlrutils para preparar as entradas e as saídas em um formato que possa ser passado para o construtor, que, na verdade, cria o procedimento armazenado.

sqlrutils fornece funções que definem o tipo e o esquema de dados de entrada e definem o tipo e o esquema de dados de saída. Ele também inclui funções que podem converter objetos R no tipo de saída necessário. Você pode fazer várias chamadas de função para criar os objetos necessários, dependendo dos tipos de dados que seu código usa.

Entradas

Se a função usar entradas, chame as seguintes funções para cada entrada:

  • setInputData se a entrada for uma estrutura de dados
  • setInputParameter para todos os outros tipos de entrada

Quando você faz cada chamada de função, é criado um objeto R que posteriormente será passado como um argumento para StoredProcedure para criar o procedimento armazenado completo.

outputs

sqlrutils fornece várias funções para converter objetos do R como listas no data.frame exigido pelo SQL Server. Se sua função gera diretamente um quadro de dados, sem primeiro encapsulá-lo em uma lista, você pode ignorar esta etapa. Você também poderá ignorar a conversão desta etapa se a função retornar NULL.

Ao converter uma lista ou obter um item específico de uma lista, escolha uma destas funções:

  • setOutputData se a variável a ser obtida da lista for uma estrutura de dados
  • setOutputParameter para todos os outros membros da lista

Quando você faz cada chamada de função, é criado um objeto R que posteriormente será passado como um argumento para StoredProcedure para criar o procedimento armazenado completo.

Etapa 3. Gerar o procedimento armazenado

Quando todos os parâmetros de entrada e saída estiverem prontos, faça uma chamada para o construtor de StoredProcedure.

Usage

StoredProcedure (func, spName, ..., filePath = NULL ,dbName = NULL, connectionString = NULL, batchSeparator = "GO")

Para ilustrar, suponha que você queira criar um procedimento armazenado chamado sp_rsample com estes parâmetros:

  • Usa uma função foosql existente. A função foi baseada em código existente na função do R foo, mas você escreveu novamente a função para estar em conformidade com os requisitos, conforme descrito nesta seção, e chamou a função atualizada de foosql.
  • Usa o estrutura de dados queryinput como entrada
  • Gera como saída uma estrutura de dados com o nome da variável R, sqloutput
  • Você deseja criar o código T-SQL como um arquivo na pasta C:\Temp para que possa executá-lo usando o SQL Server Management Studio mais tarde
StoredProcedure (foosql, sp_rsample, queryinput, sqloutput, filePath = "C:\\Temp")

Observação

Como você está gravando o arquivo no sistema de arquivos, pode omitir os argumentos que definem a conexão de banco de dados.

A saída da função é um procedimento armazenado do T-SQL que pode ser executado em uma instância do SQL Server 2016 (requer R Services) ou SQL Server 2017 (requer Serviços de Machine Learning com R).

Para obter exemplos adicionais, confira a ajuda do pacote chamando help(StoredProcedure) de um ambiente do R.

Etapa 4. Registrar e executar o procedimento armazenado

Há duas maneiras de executar o procedimento armazenado:

  • Usando o T-SQL, de qualquer cliente que seja compatível com conexões à instância do SQL Server 2016 ou do SQL Server 2017
  • De um ambiente do R

Os dois métodos exigem que o procedimento armazenado seja registrado no banco de dados em que você pretende usar o procedimento armazenado.

Registrar o procedimento armazenado

Você pode registrar o procedimento armazenado usando o R ou executar a instrução CREATE PROCEDURE no T-SQL.

  • Usando o T-SQL. Se você estiver mais familiarizado com o T-SQL, abra o SQL Server Management Studio (ou qualquer outro cliente que possa executar comandos DDL do SQL) e execute a instrução CREATE PROCEDURE usando o código preparado pela função StoredProcedure.

  • Usando o R. Ainda no ambiente do R, use a função registerStoredProcedure no sqlrutils para registrar o procedimento armazenado no banco de dados.

    Por exemplo, registre o procedimento armazenado sp_rsample na instância e no banco de dados definido em sqlConnStr, fazendo esta chamada do R:

    registerStoredProcedure(sp_rsample, sqlConnStr)

Importante

Independentemente de você usar R ou SQL, execute a instrução usando uma conta que tenha permissões para criar novos objetos de banco de dados.

Executar usando o SQL

Depois da criação do procedimento armazenado, abra uma conexão com o Banco de Dados SQL usando qualquer cliente compatível com T-SQL e passe valores para todos os parâmetros exigidos pelo procedimento armazenado.

Executar usando o R

Será necessária alguma preparação adicional se você quiser executar o procedimento armazenado do código R, em vez do SQL Server. Por exemplo, se o procedimento armazenado exigir valores de entrada, você deverá definir esses parâmetros de entrada antes que a função possa ser executada e, em seguida, passar esses objetos para o procedimento armazenado em seu código R.

O processo geral de chamar o procedimento armazenado SQL preparado é o seguinte:

  1. Chamar getInputParameters para obter uma lista de objetos de parâmetro de entrada.
  2. Definir um $query ou definir um $value para cada parâmetro de entrada.
  3. Use executeStoredProcedure para executar o procedimento armazenado no ambiente de desenvolvimento R, transmitindo a lista de objetos de parâmetro de entrada que você definiu.

Exemplo

Este exemplo mostra as versões anteriores e posteriores de um script R que obtém dados de um banco de dados do SQL Server, realiza algumas transformações nos dados e salva-os em um banco de dados diferente.

Esse exemplo simples é usado apenas para demonstrar como você pode reorganizar seu código R para facilitar a conversão em um procedimento armazenado.

Antes da preparação do código

sqlConnFrom <- "Driver={ODBC Driver 13 for SQL Server};Server=MyServer01;Database=AirlineSrc;Trusted_Connection=Yes;"
  
sqlConnTo <- "Driver={ODBC Driver 13 for SQL Server};Server=MyServer01;Database=AirlineTest;Trusted_Connection=Yes;"
  
sqlQueryAirline <- "SELECT TOP 10000 ArrDelay, CRSDepTime, DayOfWeek FROM [AirlineDemoSmall]"
  
dsSqlFrom <- RxSqlServerData(sqlQuery = sqlQueryAirline, connectionString = sqlConnFrom)
  
dsSqlTo <- RxSqlServerData(table = "cleanData", connectionString = sqlConnTo)
  
xFunc <- function(data) {
    data$CRSDepHour <- as.integer(trunc(data$CRSDepTime))
    return(data)
    }
  
xVars <- c("CRSDepTime")
  
sqlCompute <- RxInSqlServer(numTasks = 4, connectionString = sqlConnTo)
  
rxOpen(dsSqlFrom)
rxOpen(dsSqlTo)
  
if (rxSqlServerTableExists("cleanData", connectionString = sqlConnTo))   {
    rxSqlServerDropTable("cleanData")}
  
rxDataStep(inData = dsSqlFrom, 
     outFile = dsSqlTo,
     transformFunc = xFunc,
     transformVars = xVars,
     overwrite = TRUE)

Observação

Quando você usa uma conexão ODBC em vez de chamar a função RxSqlServerData, você deve abrir a conexão usando rxOpen antes de executar operações no banco de dados.

Depois da preparação do código

Na versão atualizada, a primeira linha define o nome da função. Todos os outros códigos da solução R original passam a fazer parte dessa função.

myetl1function <- function() { 
   sqlConnFrom <- "Driver={ODBC Driver 13 for SQL Server};Server=MyServer01;Database=Airline01;Trusted_Connection=Yes;"
   sqlConnTo <- "Driver={ODBC Driver 13 for SQL Server};Server=MyServer02;Database=Airline02;Trusted_Connection=Yes;"
    
   sqlQueryAirline <- "SELECT TOP 10000 ArrDelay, CRSDepTime, DayOfWeek FROM [AirlineDemoSmall]"

   dsSqlFrom <- RxSqlServerData(sqlQuery = sqlQueryAirline, connectionString = sqlConnFrom)
  
   dsSqlTo <- RxSqlServerData(table = "cleanData", connectionString = sqlConnTo)
  
   xFunc <- function(data) {
     data$CRSDepHour <- as.integer(trunc(data$CRSDepTime))
     return(data)}
  
   xVars <- c("CRSDepTime")
  
   sqlCompute <- RxInSqlServer(numTasks = 4, connectionString = sqlConnTo)
  
   if (rxSqlServerTableExists("cleanData", connectionString = sqlConnTo)) {rxSqlServerDropTable("cleanData")}
  
   rxDataStep(inData = dsSqlFrom, 
        outFile = dsSqlTo,
        transformFunc = xFunc,
        transformVars = xVars,
        overwrite = TRUE)
   return(NULL)
}

Observação

Embora você não precise explicitamente abrir a conexão ODBC como parte do seu código, uma conexão ODBC ainda é necessária para usar o sqlrutils.

Confira também

Referência sqlrutils