Skip to main content

  • ​
    updateRecords

    public <TRequest> UpdateRecordsResponse updateRecords(UpdateRecordsRequest<TRequest> request) throws GPUdbException
    Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record’s column values will be updated as provided in newValuesMaps. There is also an optional ‘upsert’ capability where if a particular predicate doesn’t match any existing record, then a new record can be inserted.

    Note that this operation can only be run on an original table and not on a result view.

    This operation can update primary key values. By default only ‘pure primary key’ predicates are allowed when updating primary key values. If the primary key for a table is the column ‘attr1’, then the operation will only accept predicates of the form: “attr1 == ‘foo’” if the attr1 column is being updated. For a composite primary key (e.g. columns ‘attr1’ and ‘attr2’) then this operation will only accept predicates of the form: “(attr1 == ‘foo’) and (attr2 == ‘bar’)”. Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each ‘pure primary key’ predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

    The UPDATE_ON_EXISTING_PK option specifies the record primary key collision policy for tables with a primary key, while IGNORE_EXISTING_PK specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

    Type Parameters:
    TRequest - The type of object being added.
    Parameters:
    request - Request object containing the parameters for the operation.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.

  • ​
    updateRecords

    public <TRequest> UpdateRecordsResponse updateRecords(TypeObjectMap<TRequest> typeObjectMap, UpdateRecordsRequest<TRequest> request) throws GPUdbException
    Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record’s column values will be updated as provided in newValuesMaps. There is also an optional ‘upsert’ capability where if a particular predicate doesn’t match any existing record, then a new record can be inserted.

    Note that this operation can only be run on an original table and not on a result view.

    This operation can update primary key values. By default only ‘pure primary key’ predicates are allowed when updating primary key values. If the primary key for a table is the column ‘attr1’, then the operation will only accept predicates of the form: “attr1 == ‘foo’” if the attr1 column is being updated. For a composite primary key (e.g. columns ‘attr1’ and ‘attr2’) then this operation will only accept predicates of the form: “(attr1 == ‘foo’) and (attr2 == ‘bar’)”. Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each ‘pure primary key’ predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

    The UPDATE_ON_EXISTING_PK option specifies the record primary key collision policy for tables with a primary key, while IGNORE_EXISTING_PK specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

    Type Parameters:
    TRequest - The type of object being added.
    Parameters:
    typeObjectMap - Type object map used for encoding input objects.
    request - Request object containing the parameters for the operation.
    Returns:
    Response object containing the results of the operation.
    Throws:
    IllegalArgumentException - if typeObjectMap is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    GPUdbException - if an error occurs during the operation.

  • ​
    updateRecords

    public <TRequest> UpdateRecordsResponse updateRecords(String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<TRequest> data, Map<String,String> options) throws GPUdbException
    Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record’s column values will be updated as provided in newValuesMaps. There is also an optional ‘upsert’ capability where if a particular predicate doesn’t match any existing record, then a new record can be inserted.

    Note that this operation can only be run on an original table and not on a result view.

    This operation can update primary key values. By default only ‘pure primary key’ predicates are allowed when updating primary key values. If the primary key for a table is the column ‘attr1’, then the operation will only accept predicates of the form: “attr1 == ‘foo’” if the attr1 column is being updated. For a composite primary key (e.g. columns ‘attr1’ and ‘attr2’) then this operation will only accept predicates of the form: “(attr1 == ‘foo’) and (attr2 == ‘bar’)”. Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each ‘pure primary key’ predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

    The UPDATE_ON_EXISTING_PK option specifies the record primary key collision policy for tables with a primary key, while IGNORE_EXISTING_PK specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

    Type Parameters:
    TRequest - The type of object being added.
    Parameters:
    tableName - Name of table to be updated, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table and not a view.
    expressions - A list of the actual predicates, one for each update; format should follow the guidelines here.
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    data - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.
    options - Optional parameters.
    • GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ”.
    • BYPASS_SAFETY_CHECKS: When set to TRUE, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values:The default value is FALSE.
    • ERROR_HANDLING: Specifies how record errors are handled during the update’s reinsert (including any alternate insert records supplied via data). When set, this option is authoritative for the reinsert. Primary-key collision behavior is governed by UPDATE_ON_EXISTING_PK and IGNORE_EXISTING_PK. Supported values:
      • PERMISSIVE: Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported.
      • SKIP: Records with bad values are skipped and reported; the rest of the batch is applied.
      • ABORT: Stops the update and rejects the remaining batch when any record is incorrect.
      The default value is ABORT.
    • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for updating a table with a primary key. There are two ways that a record collision can occur. The first is an “update collision”, which happens when the update changes the value of the updated record’s primary key, and that new primary key already exists as the primary key of another record in the table. The second is an “insert collision”, which occurs when a given filter in expressions finds no records to update, and the alternate insert record given in data (or recordsToInsertStr) contains a primary key matching that of an existing record in the table. If UPDATE_ON_EXISTING_PK is set to TRUE, “update collisions” will result in the existing record collided into being removed and the record updated with values specified in newValuesMaps taking its place; “insert collisions” will result in the collided-into record being updated with the values in data / recordsToInsertStr (if given). If set to FALSE, the existing collided-into record will remain unchanged, while the update will be rejected and the error handled as determined by IGNORE_EXISTING_PK. If the specified table does not have a primary key, then this option has no effect. Supported values:
      • TRUE: Overwrite the collided-into record when updating a record’s primary key or inserting an alternate record causes a primary key collision between the record being updated/inserted and another existing record in the table
      • FALSE: Reject updates which cause primary key collisions between the record being updated/inserted and an existing record in the table
      The default value is FALSE.
    • PK_CONFLICT_PREDICATE_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ”.
    • PK_CONFLICT_PREDICATE_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ”.
    • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (UPDATE_ON_EXISTING_PK is FALSE). If set to TRUE, any record update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If FALSE, the rejection of any update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if UPDATE_ON_EXISTING_PK is TRUE, then this option has no effect. Supported values:
      • TRUE: Ignore updates that result in primary key collisions with existing records.
      • FALSE: Treat as errors any updates that result in primary key collisions with existing records.
      The default value is FALSE.
    • UPDATE_PARTITION: Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. Supported values:The default value is FALSE.
    • ENABLE_INPLACE_UPDATES: If set to TRUE, qualifying records are modified in place. If set to FALSE, they are updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:The default value is TRUE.
    • ENABLE_WORKER_OOP_UPDATE: For an out-of-place update (delete and insert), controls where the replacement records are reinserted. If set to TRUE, the workers that own the data reinsert them directly, avoiding a round trip through the head node; a shard-key change reshards the replacements to their new owning workers. If set to FALSE, the replacement records are reinserted from the head node. Overrides the feature.enable_worker_oop_update@ configuration default. Supported values:
    • TRUNCATE_STRINGS: If set to TRUE, any strings which are too long for their charN string fields will be truncated to fit. Supported values:The default value is FALSE.
    • USE_EXPRESSIONS_IN_NEW_VALUES_MAPS: When set to TRUE, all new values in newValuesMaps are considered as expression values. When set to FALSE, all new values in newValuesMaps are considered as constants. NOTE: When TRUE, string constants will need to be quoted to avoid being evaluated as expressions. Supported values:The default value is FALSE.
    • RECORD_ID: ID of a single record to be updated (returned in the call to insertRecords or getRecordsFromCollection).
    The default value is an empty Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.

  • ​
    updateRecords

    public <TRequest> UpdateRecordsResponse updateRecords(TypeObjectMap<TRequest> typeObjectMap, String tableName, List<String> expressions, List<Map<String,String>> newValuesMaps, List<TRequest> data, Map<String,String> options) throws GPUdbException
    Runs multiple predicate-based updates in a single call. With the list of given expressions, any matching record’s column values will be updated as provided in newValuesMaps. There is also an optional ‘upsert’ capability where if a particular predicate doesn’t match any existing record, then a new record can be inserted.

    Note that this operation can only be run on an original table and not on a result view.

    This operation can update primary key values. By default only ‘pure primary key’ predicates are allowed when updating primary key values. If the primary key for a table is the column ‘attr1’, then the operation will only accept predicates of the form: “attr1 == ‘foo’” if the attr1 column is being updated. For a composite primary key (e.g. columns ‘attr1’ and ‘attr2’) then this operation will only accept predicates of the form: “(attr1 == ‘foo’) and (attr2 == ‘bar’)”. Meaning, all primary key columns must appear in an equality predicate in the expressions. Furthermore each ‘pure primary key’ predicate must be unique within a given request. These restrictions can be removed by utilizing some available options through options.

    The UPDATE_ON_EXISTING_PK option specifies the record primary key collision policy for tables with a primary key, while IGNORE_EXISTING_PK specifies the record primary key collision error-suppression policy when those collisions result in the update being rejected. Both are ignored on tables with no primary key.

    Type Parameters:
    TRequest - The type of object being added.
    Parameters:
    typeObjectMap - Type object map used for encoding input objects.
    tableName - Name of table to be updated, in [schema_name.]table_name format, using standard name resolution rules. Must be a currently existing table and not a view.
    expressions - A list of the actual predicates, one for each update; format should follow the guidelines here.
    newValuesMaps - List of new values for the matching records. Each element is a map with (key, value) pairs where the keys are the names of the columns whose values are to be updated; the values are the new values. The number of elements in the list should match the length of expressions.
    data - An *optional* list of new binary-avro encoded records to insert, one for each update. If one of expressions does not yield a matching record to be updated, then the corresponding element from this list will be added to the table. The default value is an empty List.
    options - Optional parameters.
    • GLOBAL_EXPRESSION: An optional global expression to reduce the search space of the predicates listed in expressions. The default value is ”.
    • BYPASS_SAFETY_CHECKS: When set to TRUE, all predicates are available for primary key updates. Keep in mind that it is possible to destroy data in this case, since a single predicate may match multiple objects (potentially all of records of a table), and then updating all of those records to have the same primary key will, due to the primary key uniqueness constraints, effectively delete all but one of those updated records. Supported values:The default value is FALSE.
    • ERROR_HANDLING: Specifies how record errors are handled during the update’s reinsert (including any alternate insert records supplied via data). When set, this option is authoritative for the reinsert. Primary-key collision behavior is governed by UPDATE_ON_EXISTING_PK and IGNORE_EXISTING_PK. Supported values:
      • PERMISSIVE: Records with bad column values are kept when possible: the offending column is filled with its default value if one exists, otherwise with null if the column is nullable; if neither is possible the record is skipped and reported.
      • SKIP: Records with bad values are skipped and reported; the rest of the batch is applied.
      • ABORT: Stops the update and rejects the remaining batch when any record is incorrect.
      The default value is ABORT.
    • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for updating a table with a primary key. There are two ways that a record collision can occur. The first is an “update collision”, which happens when the update changes the value of the updated record’s primary key, and that new primary key already exists as the primary key of another record in the table. The second is an “insert collision”, which occurs when a given filter in expressions finds no records to update, and the alternate insert record given in data (or recordsToInsertStr) contains a primary key matching that of an existing record in the table. If UPDATE_ON_EXISTING_PK is set to TRUE, “update collisions” will result in the existing record collided into being removed and the record updated with values specified in newValuesMaps taking its place; “insert collisions” will result in the collided-into record being updated with the values in data / recordsToInsertStr (if given). If set to FALSE, the existing collided-into record will remain unchanged, while the update will be rejected and the error handled as determined by IGNORE_EXISTING_PK. If the specified table does not have a primary key, then this option has no effect. Supported values:
      • TRUE: Overwrite the collided-into record when updating a record’s primary key or inserting an alternate record causes a primary key collision between the record being updated/inserted and another existing record in the table
      • FALSE: Reject updates which cause primary key collisions between the record being updated/inserted and an existing record in the table
      The default value is FALSE.
    • PK_CONFLICT_PREDICATE_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ”.
    • PK_CONFLICT_PREDICATE_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ”.
    • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for updating a table with a primary key, only used when primary key record collisions are rejected (UPDATE_ON_EXISTING_PK is FALSE). If set to TRUE, any record update that is rejected for resulting in a primary key collision with an existing table record will be ignored with no error generated. If FALSE, the rejection of any update for resulting in a primary key collision will cause an error to be reported. If the specified table does not have a primary key or if UPDATE_ON_EXISTING_PK is TRUE, then this option has no effect. Supported values:
      • TRUE: Ignore updates that result in primary key collisions with existing records.
      • FALSE: Treat as errors any updates that result in primary key collisions with existing records.
      The default value is FALSE.
    • UPDATE_PARTITION: Force qualifying records to be deleted and reinserted so their partition membership will be reevaluated. Supported values:The default value is FALSE.
    • ENABLE_INPLACE_UPDATES: If set to TRUE, qualifying records are modified in place. If set to FALSE, they are updated by deleting the existing record and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:The default value is TRUE.
    • ENABLE_WORKER_OOP_UPDATE: For an out-of-place update (delete and insert), controls where the replacement records are reinserted. If set to TRUE, the workers that own the data reinsert them directly, avoiding a round trip through the head node; a shard-key change reshards the replacements to their new owning workers. If set to FALSE, the replacement records are reinserted from the head node. Overrides the feature.enable_worker_oop_update@ configuration default. Supported values:
    • TRUNCATE_STRINGS: If set to TRUE, any strings which are too long for their charN string fields will be truncated to fit. Supported values:The default value is FALSE.
    • USE_EXPRESSIONS_IN_NEW_VALUES_MAPS: When set to TRUE, all new values in newValuesMaps are considered as expression values. When set to FALSE, all new values in newValuesMaps are considered as constants. NOTE: When TRUE, string constants will need to be quoted to avoid being evaluated as expressions. Supported values:The default value is FALSE.
    • RECORD_ID: ID of a single record to be updated (returned in the call to insertRecords or getRecordsFromCollection).
    The default value is an empty Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    IllegalArgumentException - if typeObjectMap is not an instance of one of the following: Type, TypeObjectMap, Schema, or a Class that implements IndexedRecord
    GPUdbException - if an error occurs during the operation.