revoscalepy.rx_delete_object(src: revoscalepy.datasource.RxOdbcData.RxOdbcData,
    key: str = None, version: str = None,
    key_name: str = 'id', version_name: str = 'version',
    all: bool = False)


Deletes an object from an ODBC data source. The APIs are modelled after a simple key value store.


Deletes an object from the ODBC data source. If there are multiple objects identified by the key/version combination, all are deleted.

The key and the version column should be of some SQL character type (CHAR, VARCHAR, NVARCHAR, etc) supported by the data source. The value column should be a binary type (VARBINARY for instance). Some conversions to other types might work, however, they are dependant on the ODBC driver and on the underlying package functions.



The object being stored into the data source.


A character string identifying the object. The intended use is for the key+version to be unique.


None or a character string which carries the version of the object. Combined with key identifies the object.


Character string specifying the column name for the key in the underlying table.


Character string specifying the column name for the version in the underlying table.


Bool value. True to remove all objects from the data source. If True, the ‘key’ parameter is ignored.


rx_read_object returns an object. rx_write_object and rx_delete_object return bool, True on success. rx_list_keys returns a single column data frame containing strings.


from pandas import DataFrame
from numpy import random
from revoscalepy import RxOdbcData, rx_write_object, rx_read_object, rx_list_keys, rx_delete_object

connection_string = 'Driver=SQL Server;Server=.;Database=RevoTestDb;Trusted_Connection=True;'
dest = RxOdbcData(connection_string, table = "dataframe")

df = DataFrame(random.randn(10, 5))

status = rx_write_object(dest, key = "myDf", value = df)

read_obj = rx_read_object(dest, key = "myDf")

keys = rx_list_keys(dest)

rx_delete_object(dest, key = "myDf")