R: Update existing rows of data in a labkey database

labkey.updateRows {Rlabkey} | R Documentation

## Update existing rows of data in a labkey database

### Description

Send data from an R session to update existing rows of data in the database.

### Usage

    labkey.updateRows(baseUrl, folderPath,
        schemaName, queryName, toUpdate, provenanceParams=NULL)

### Arguments

`baseUrl` | a string specifying the `baseUrl`for the labkey server
`folderPath` | a string specifying the `folderPath`
`schemaName` | a string specifying the `schemaName`for the query
`queryName` | a string specifying the `queryName`
`toUpdate` | a data frame containing the row(s) of data to be updated
`provenanceParams` | the provenance parameter object which contains the options to include as part of a provenance recording. This is a premium feature and requires the Provenance LabKey module to function correctly, if it is not present this parameter will be ignored.

### Details

A single row or multiple rows of data can be updated. The `toUpdate` data frame should contain the rows of data to be updated and must be created with the `stringsAsFactors` option set to FALSE. The names of the data in the data frame must be the column names from the labkey database. To update a row/column to a value of NULL, use an empty string ("") in the data frame (regardless of the database column type).

### Value

A list is returned with named categories of command, rowsAffected, rows, queryName, containerPath and schemaName. The schemaName, queryName and containerPath properties contain the same schema, query and folder path used in the request. The rowsAffected property indicates the number of rows affected by the API action. This will typically be the same number as passed in the request. The rows property contains a list of row objects corresponding to the rows updated.

### Author(s)

Valerie Obenchain

### See Also

`labkey.selectRows`, `labkey.executeSql`, `makeFilter`, `labkey.insertRows`, `labkey.importRows`,
`labkey.deleteRows`, `labkey.query.import`, `labkey.provenance.createProvenanceParams`, `labkey.provenance.startRecording`, `labkey.provenance.addRecordingStep`, `labkey.provenance.stopRecording`

### Examples

    ## Insert, update and delete
    ## Note that users must have the necessary permissions in the database
    ## to be able to modify data through the use of these functions
    # library(Rlabkey)

    newrow <- data.frame(
    	DisplayFld="Inserted from R"
    	, TextFld="how its done"
    	, IntFld= 98
    	, DoubleFld = 12.345
    	, DateTimeFld = "03/01/2010"
    	, BooleanFld= FALSE
    	, LongTextFld = "Four score and seven years ago"
    #	, AttachmentFld = NA    		#attachment fields not supported
    	, RequiredText = "Veni, vidi, vici"
    	, RequiredInt = 0
    	, Category = "LOOKUP2"
    	, stringsAsFactors=FALSE)

    insertedRow <- labkey.insertRows("http://localhost:8080/labkey",
        folderPath="/apisamples", schemaName="lists", queryName="AllTypes",
        toInsert=newrow)
    newRowId <- insertedRow$rows[[1]]$RowId

    selectedRow<-labkey.selectRows("http://localhost:8080/labkey",
        folderPath="/apisamples", schemaName="lists", queryName="AllTypes",
        colFilter=makeFilter(c("RowId", "EQUALS", newRowId)))
    selectedRow

    updaterow=data.frame(
    	RowId=newRowId
    	, DisplayFld="Updated from R"
    	, TextFld="how to update"
    	, IntFld= 777
    	, stringsAsFactors=FALSE)

    updatedRow <- labkey.updateRows("http://localhost:8080/labkey",
        folderPath="/apisamples", schemaName="lists", queryName="AllTypes",
        toUpdate=updaterow)
    selectedRow<-labkey.selectRows("http://localhost:8080/labkey",
        folderPath="/apisamples", schemaName="lists", queryName="AllTypes",
        colFilter=makeFilter(c("RowId", "EQUALS", newRowId)))
    selectedRow

    deleterow <- data.frame(RowId=newRowId, stringsAsFactors=FALSE)
    result <- labkey.deleteRows(baseUrl="http://localhost:8080/labkey",
        folderPath="/apisamples", schemaName="lists", queryName="AllTypes",
        toDelete=deleterow)
    str(result)

[Package Rlabkey version 2.8.4 Index]