command cdb_batchDelete pDataA, pTarget, pInternalA

Updated 11/22/19

Summary

This function deletes a set of records.

Inputs

  • pDataA (Array) - A multidimensional array, where each key is a tableID that maps to another array where the keys are recordIDs, and the elements are empty. There must be at least one tableID key in the array.

    • [tableID 1] (Array) - The first table's ID, maps to subarray of record IDs.
      • [cdbRecordID 1] - Key that is the recordID for the first record to be deleted, or "*" to delete all records in a table.
        • empty - The value of the corresponding key must be empty.
      • *[cdbRecordID N] - Key that is the record ID for the nth record to be deleted.
        • empty - The value of the corresponding key must be empty.
    • *[tableID N] (Array) - Key that is the nth table's ID. Repeat tableID1's sublevel structure.

  • pTarget (String) - The place to delete record(s), either "cloud" or "local".

  • *pInternalA (Array) - An array whose key is "delaySend" and its value is true. Optional parameter if pTarget is "cloud." This will delay processing the cloud call and will store its transaction in "cdbCache." Use cdb_flushCache to process the delayed transactions.

*optional parameter.

Note: To delete all the records for a given table, use "*" as key mapping to empty in place of the array of cdbRecordID keys.

BatchDelete input diagram

Additional Requirements

This API call requires internet access in order to delete cloud records.

Examples

local tDataA, tTarget, tClientsTableID, tOfficeTableID

# Table name: clients                       
# cdbRecordIDs: 
# 12345678-abcd-1234-cdef-1234567890ab     
# 87654321-abcd-1234-cdef-1234567890ab

# Table name: office
# cdbRecordIDs:
# 45678123-abcd-1234-cdef-1234567890ab

put cdb_tableID("clients") into tClientsTableID                                       
put cdb_tableID("office") into tOfficeTableID

put empty into tDataA[tClientsTableID]["*"]
put empty into tDataA[tOfficeTableID]["45678123-abcd-1234-cdef-1234567890ab"]

put "cloud" into tTarget

cdb_batchDelete tDataA,tTarget

# Now both tables have no records

local tDataA, tTarget, tInternalA, tClientsTableID, tOfficeTableID

# Table name: clients                       
# cdbRecordIDs: 
# 32165478-wxyz-7890-cdef-6544567890ty

# Table name: office
# cdbRecordIDs:
# 98778124-idfd-6544-efgf-8744532890po

put cdb_tableID("clients") into tClientsTableID               
put cdb_tableID("office") into tOfficeTableID

put empty into tDataA[tClientsTableID]["32165478-wxyz-7890-cdef-6544567890ty"]
put empty into tDataA[tOfficeTableID]["98778124-idfd-6544-efgf-8744532890po"]

put "cloud" into tTarget
put true into tInternalA["delaySend"]

cdb_batchDelete tDataA,tTarget,tInternalA

# Process the delayed transaction
cdb_flushCache