# Copyright (C) 2017 Juergen Altfeld, Mateusz Zoltak
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 or 3 of the License
# (at your option).
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# A copy of the GNU General Public License is available at
# http://www.r-project.org/Licenses/
#' @title Sets the query timeout of a prepared query
#' @description A query has to be already prepared using SQLPrepare()
#'
#' Throws an error if any error occured
#' @param channel an open RODBC channel (connection)
#' @param timeout the new query timeout value in seconds (0 means "no timeout")
#' @return 0 = success, 1 = success but with an info message,
#' @seealso \code{\link{odbcGetQueryTimeout}}, \code{\link{odbcConnect}},
#' \code{\link{odbcDriverConnect}}
#' @note Not all drivers will support a query timeout. You may get an error then
#' or the query timeout values remains unchanged silently.
#' @examples
#' \dontrun{
#' conn = odbcConnect('MyDataSource')
#'
#' sqlPrepare(conn, "SELECT * FROM myTable WHERE column = ?")
#' odbcSetQueryTimeout(conn, 120) # sets the query timeout of the prepared statement
#' sqlExecute(conn, 'myValue')
#' sqlFetchMore(conn)
#' }
#'
#' @export
odbcSetQueryTimeout = function(channel, timeout = 0)
{
stopifnot(
odbcValidChannel(channel),
is.vector(timeout), is.numeric(timeout), length(timeout) == 1, all(!is.na(timeout))
)
stat = .Call("RODBCSetQueryTimeout", attr(channel, "handle_ptr"), timeout)
if (stat == -1L) {
stop(paste0(RODBC::odbcGetErrMsg(channel), collapse = '\n'))
}
# surprisingly many drivers do not support query timeouts silently
currTimeout = odbcGetQueryTimeout(channel)
if (currTimeout != timeout) {
stop('The ODBC driver returned no error but the timeout was not set.\nIt looks like the ODBC driver you are using does not support query timeouts.')
} else {
return(stat)
}
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.