Mutation Operations

This reference doc is generated based on this example schema.

Mutations define the write operations for modifying data in a GraphQL schema.

All mutations are generated based on customer defined @table types. Customer defined mutations are not supported.

Data Connect Generated

mainTable_delete: MainTable_KeyOutput

✨ Delete a single MainTable based on id, key or first and return its key (or null if not found).

Field Type Description
id UUID The unique ID of the object.
key MainTable_Key The key used to identify the object.
first MainTable_FirstRow Fetch the first row based on the filters and ordering.

mainTable_deleteMany: Int!

✨ Delete MainTable objects matching where conditions (or all, if true). Returns the number of rows deleted.

Field Type Description
where MainTable_Filter Filter condition to specify which rows to delete.
all Boolean Set to true to delete all rows.

mainTable_insert: MainTable_KeyOutput!

✨ Insert a single MainTable into the table and return its key. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data MainTable_Data! Data object to insert into the table.

mainTable_insertMany: [MainTable_KeyOutput!]!

✨ Insert MainTable objects into the table and return their keys. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data [MainTable_Data!]! List of data objects to insert into the table.

mainTable_update: MainTable_KeyOutput

✨ Update a single MainTable based on id, key or first, setting columns specified in data. Returns the key of the updated MainTable or null if not found.

Field Type Description
id UUID The unique ID of the object.
key MainTable_Key The key used to identify the object.
first MainTable_FirstRow Fetch the first row based on the filters and ordering.
data MainTable_Data! Data object containing fields to be updated.

mainTable_updateMany: Int!

✨ Update MainTable objects matching where conditions (or all, if true) according to data. Returns the number of rows updated.

Field Type Description
where MainTable_Filter Filter condition to specify which rows to update.
all Boolean Set to true to update all rows.
data MainTable_Data! Data object containing fields to update.

mainTable_upsert: MainTable_KeyOutput!

✨ Insert or update a single MainTable into the table, based on the primary key. Returns the key of the newly inserted or existing updated MainTable.

Field Type Description
data MainTable_Data! Data object to insert or update if it already exists.

mainTable_upsertMany: [MainTable_KeyOutput!]!

✨ Insert or update MainTable objects into the table, based on the primary key. Returns the key of the newly inserted or existing updated MainTable.

Field Type Description
data [MainTable_Data!]! List of data objects to insert or update if it already exists.

manyToManyJoinTable_delete: ManyToManyJoinTable_KeyOutput

✨ Delete a single ManyToManyJoinTable based on id, key or first and return its key (or null if not found).

Field Type Description
key ManyToManyJoinTable_Key The key used to identify the object.
first ManyToManyJoinTable_FirstRow Fetch the first row based on the filters and ordering.

manyToManyJoinTable_deleteMany: Int!

✨ Delete ManyToManyJoinTable objects matching where conditions (or all, if true). Returns the number of rows deleted.

Field Type Description
where ManyToManyJoinTable_Filter Filter condition to specify which rows to delete.
all Boolean Set to true to delete all rows.

manyToManyJoinTable_insert: ManyToManyJoinTable_KeyOutput!

✨ Insert a single ManyToManyJoinTable into the table and return its key. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data ManyToManyJoinTable_Data! Data object to insert into the table.

manyToManyJoinTable_insertMany: [ManyToManyJoinTable_KeyOutput!]!

✨ Insert ManyToManyJoinTable objects into the table and return their keys. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data [ManyToManyJoinTable_Data!]! List of data objects to insert into the table.

manyToManyJoinTable_update: ManyToManyJoinTable_KeyOutput

✨ Update a single ManyToManyJoinTable based on id, key or first, setting columns specified in data. Returns the key of the updated ManyToManyJoinTable or null if not found.

Field Type Description
key ManyToManyJoinTable_Key The key used to identify the object.
first ManyToManyJoinTable_FirstRow Fetch the first row based on the filters and ordering.
data ManyToManyJoinTable_Data! Data object containing fields to be updated.

manyToManyJoinTable_updateMany: Int!

✨ Update ManyToManyJoinTable objects matching where conditions (or all, if true) according to data. Returns the number of rows updated.

Field Type Description
where ManyToManyJoinTable_Filter Filter condition to specify which rows to update.
all Boolean Set to true to update all rows.
data ManyToManyJoinTable_Data! Data object containing fields to update.

manyToManyJoinTable_upsert: ManyToManyJoinTable_KeyOutput!

✨ Insert or update a single ManyToManyJoinTable into the table, based on the primary key. Returns the key of the newly inserted or existing updated ManyToManyJoinTable.

Field Type Description
data ManyToManyJoinTable_Data! Data object to insert or update if it already exists.

manyToManyJoinTable_upsertMany: [ManyToManyJoinTable_KeyOutput!]!

✨ Insert or update ManyToManyJoinTable objects into the table, based on the primary key. Returns the key of the newly inserted or existing updated ManyToManyJoinTable.

Field Type Description
data [ManyToManyJoinTable_Data!]! List of data objects to insert or update if it already exists.

manyToOneExample_delete: ManyToOneExample_KeyOutput

✨ Delete a single ManyToOneExample based on id, key or first and return its key (or null if not found).

Field Type Description
id UUID The unique ID of the object.
key ManyToOneExample_Key The key used to identify the object.
first ManyToOneExample_FirstRow Fetch the first row based on the filters and ordering.

manyToOneExample_deleteMany: Int!

✨ Delete ManyToOneExample objects matching where conditions (or all, if true). Returns the number of rows deleted.

Field Type Description
where ManyToOneExample_Filter Filter condition to specify which rows to delete.
all Boolean Set to true to delete all rows.

manyToOneExample_insert: ManyToOneExample_KeyOutput!

✨ Insert a single ManyToOneExample into the table and return its key. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data ManyToOneExample_Data! Data object to insert into the table.

manyToOneExample_insertMany: [ManyToOneExample_KeyOutput!]!

✨ Insert ManyToOneExample objects into the table and return their keys. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data [ManyToOneExample_Data!]! List of data objects to insert into the table.

manyToOneExample_update: ManyToOneExample_KeyOutput

✨ Update a single ManyToOneExample based on id, key or first, setting columns specified in data. Returns the key of the updated ManyToOneExample or null if not found.

Field Type Description
id UUID The unique ID of the object.
key ManyToOneExample_Key The key used to identify the object.
first ManyToOneExample_FirstRow Fetch the first row based on the filters and ordering.
data ManyToOneExample_Data! Data object containing fields to be updated.

manyToOneExample_updateMany: Int!

✨ Update ManyToOneExample objects matching where conditions (or all, if true) according to data. Returns the number of rows updated.

Field Type Description
where ManyToOneExample_Filter Filter condition to specify which rows to update.
all Boolean Set to true to update all rows.
data ManyToOneExample_Data! Data object containing fields to update.

manyToOneExample_upsert: ManyToOneExample_KeyOutput!

✨ Insert or update a single ManyToOneExample into the table, based on the primary key. Returns the key of the newly inserted or existing updated ManyToOneExample.

Field Type Description
data ManyToOneExample_Data! Data object to insert or update if it already exists.

manyToOneExample_upsertMany: [ManyToOneExample_KeyOutput!]!

✨ Insert or update ManyToOneExample objects into the table, based on the primary key. Returns the key of the newly inserted or existing updated ManyToOneExample.

Field Type Description
data [ManyToOneExample_Data!]! List of data objects to insert or update if it already exists.

oneToOneExample_delete: OneToOneExample_KeyOutput

✨ Delete a single OneToOneExample based on id, key or first and return its key (or null if not found).

Field Type Description
id UUID The unique ID of the object.
key OneToOneExample_Key The key used to identify the object.
first OneToOneExample_FirstRow Fetch the first row based on the filters and ordering.

oneToOneExample_deleteMany: Int!

✨ Delete OneToOneExample objects matching where conditions (or all, if true). Returns the number of rows deleted.

Field Type Description
where OneToOneExample_Filter Filter condition to specify which rows to delete.
all Boolean Set to true to delete all rows.

oneToOneExample_insert: OneToOneExample_KeyOutput!

✨ Insert a single OneToOneExample into the table and return its key. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data OneToOneExample_Data! Data object to insert into the table.

oneToOneExample_insertMany: [OneToOneExample_KeyOutput!]!

✨ Insert OneToOneExample objects into the table and return their keys. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data [OneToOneExample_Data!]! List of data objects to insert into the table.

oneToOneExample_update: OneToOneExample_KeyOutput

✨ Update a single OneToOneExample based on id, key or first, setting columns specified in data. Returns the key of the updated OneToOneExample or null if not found.

Field Type Description
id UUID The unique ID of the object.
key OneToOneExample_Key The key used to identify the object.
first OneToOneExample_FirstRow Fetch the first row based on the filters and ordering.
data OneToOneExample_Data! Data object containing fields to be updated.

oneToOneExample_updateMany: Int!

✨ Update OneToOneExample objects matching where conditions (or all, if true) according to data. Returns the number of rows updated.

Field Type Description
where OneToOneExample_Filter Filter condition to specify which rows to update.
all Boolean Set to true to update all rows.
data OneToOneExample_Data! Data object containing fields to update.

oneToOneExample_upsert: OneToOneExample_KeyOutput!

✨ Insert or update a single OneToOneExample into the table, based on the primary key. Returns the key of the newly inserted or existing updated OneToOneExample.

Field Type Description
data OneToOneExample_Data! Data object to insert or update if it already exists.

oneToOneExample_upsertMany: [OneToOneExample_KeyOutput!]!

✨ Insert or update OneToOneExample objects into the table, based on the primary key. Returns the key of the newly inserted or existing updated OneToOneExample.

Field Type Description
data [OneToOneExample_Data!]! List of data objects to insert or update if it already exists.

stringTable_delete: StringTable_KeyOutput

✨ Delete a single StringTable based on id, key or first and return its key (or null if not found).

Field Type Description
id UUID The unique ID of the object.
key StringTable_Key The key used to identify the object.
first StringTable_FirstRow Fetch the first row based on the filters and ordering.

stringTable_deleteMany: Int!

✨ Delete StringTable objects matching where conditions (or all, if true). Returns the number of rows deleted.

Field Type Description
where StringTable_Filter Filter condition to specify which rows to delete.
all Boolean Set to true to delete all rows.

stringTable_insert: StringTable_KeyOutput!

✨ Insert a single StringTable into the table and return its key. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data StringTable_Data! Data object to insert into the table.

stringTable_insertMany: [StringTable_KeyOutput!]!

✨ Insert StringTable objects into the table and return their keys. Columns not specified in data will receive defaults (e.g. null).

Field Type Description
data [StringTable_Data!]! List of data objects to insert into the table.

stringTable_update: StringTable_KeyOutput

✨ Update a single StringTable based on id, key or first, setting columns specified in data. Returns the key of the updated StringTable or null if not found.

Field Type Description
id UUID The unique ID of the object.
key StringTable_Key The key used to identify the object.
first StringTable_FirstRow Fetch the first row based on the filters and ordering.
data StringTable_Data! Data object containing fields to be updated.

stringTable_updateMany: Int!

✨ Update StringTable objects matching where conditions (or all, if true) according to data. Returns the number of rows updated.

Field Type Description
where StringTable_Filter Filter condition to specify which rows to update.
all Boolean Set to true to update all rows.
data StringTable_Data! Data object containing fields to update.

stringTable_upsert: StringTable_KeyOutput!

✨ Insert or update a single StringTable into the table, based on the primary key. Returns the key of the newly inserted or existing updated StringTable.

Field Type Description
data StringTable_Data! Data object to insert or update if it already exists.

stringTable_upsertMany: [StringTable_KeyOutput!]!

✨ Insert or update StringTable objects into the table, based on the primary key. Returns the key of the newly inserted or existing updated StringTable.

Field Type Description
data [StringTable_Data!]! List of data objects to insert or update if it already exists.