AlterTransaction

Description

      description: |
        Alter a transaction with a list of actions such as setting status or properties.
        The server should either succeed and apply all actions, or fail and apply no action.

Request Schema

    AlterTransactionRequest:
      type: object
      description: |
        Alter a transaction with a list of actions.
        The server should either succeed and apply all actions, or fail and apply no action.
      required:
        - actions
      properties:
        id:
          type: array
          items:
            type: string
        actions:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/AlterTransactionAction'

Supporting action schemas:

Set Status Action:

          default: false
        when_not_matched_by_source_delete_filt:
          description: Delete rows from the target table if there is no match AND the SQL expression evaluates to true
          type: string

    MergeInsertIntoTableResponse:

Set Property Action:

      type: object
      description: Response from merge insert operation
      properties:
        num_updated_rows:
          type: integer
          format: int64
          description: Number of rows updated
          minimum: 0
        num_inserted_rows:
          type: integer

Unset Property Action:

          minimum: 0

    UpdateTableRequest:
      type: object
      description: |
        Each update consists of a column name and an SQL expression that will be
        evaluated against the current row's value. Optionally, a predicate can be
        provided to filter which rows to update.

Response Schema

    AlterTransactionResponse:
      type: object
      required:
        - status
      properties:
        status:
          $ref: '#/components/schemas/TransactionStatus'
        properties:
          type: object
          additionalProperties:
            type: string

Related Components Schema

Set Status Action

    AlterTransactionSetStatus:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/TransactionStatus'

Set Property Action

    AlterTransactionSetProperty:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
        mode:
          $ref: '#/components/schemas/SetPropertyMode'

Unset Property Action

    AlterTransactionUnsetProperty:
      type: object
      properties:
        key:
          type: string
        mode:
          $ref: '#/components/schemas/UnsetPropertyMode'