OData.CRUD

Members

---

<inner> Given we have created a new empty record

Description

Create a new empty record targeting previously specified entity

Examples

Given we have created a new empty record

---

<inner> Given we have created a new empty record in entity {word}

Description

Create a new empty record targeting the specified entity

Parameters

Name	Type	Description
entity	word	target entity name

Examples

Given we have created a new empty record in entity Books

---

<inner> Given we have created a new record

Description

Create a new record targeting previously specified entity

Parameters

Name	Type	Description
data	attachment	provides JSON-formatted record

Examples

Given we have created a new record
			"""
			{ "id":1, "name": "new instance" }
			"""

---

<inner> Given we have created a new record in entity {word}

Description

Create a new record targeting the specified entity

Parameters

Name	Type	Description
entity	word	target entity name
data	attachment	provides JSON-formatted record

Examples

Given we have created a new record in entity Books
			"""
			{ "id":1, "name": "new book" }
			"""

---

<inner> Given we have created new records in entity {word}

Description

Create a new record targeting the specified entity

Parameters

Name	Type	Description
entity	word	target entity name
data	attachment	provides the JSON-formatted record

Examples

Given we have created new records in entity {word}

---

<inner> Given we have created a new record with {word} set to {float}

Description

Create a new record targeting previously specified entity

Parameters

Name	Type	Description
field	word	name of the target field
value	float	float value to store into the specified field

Examples

Given we have created a new record with Price set to 12,50

---

<inner> Given we have created a new record with {word} set to {string}

Description

Create a new record targeting previously specified entity

Parameters

Name	Type	Description
field	word	name of the target field
value	string	string value to store into the specified field

Examples

Given we have created a new record with Name set to "New Name"

---

<inner> Given we have created a new record with {word} set to {word}

Description

Create a new record targeting previously specified entity

Parameters

Name	Type	Description
field	word	name of the target field
value	word	value to store into the specified field

Examples

Given we have created a new record with Status set to Open

---

<inner> Given we have read records matching {word} equal to {string}

Description

Performs a read request targeting previously specified entity while filtering by the specified field equal to the provided value

Parameters

Name	Type	Description
field	word	name of the field to use in the filter
value	string	exact value to match the specified field with

Examples

Given we have read records matching Title equal to "New Title"

---

<inner> When we read all records

Description

Performs a read request without any restrictions targeting previously specified entity

Examples

When we read all records

---

<inner> When we read all records from entity {word}

Description

Performs a read request without any restrictions targeting the specified entity

Parameters

Name	Type	Description
entity	word	target entity name

Examples

When we read all records from entity Books

---

<inner> When we read entity {word} by selecting the following fields

Description

Performs a read request targeting the specified entity and obtaining only the requested fields

Parameters

Name	Type	Description
entity	word	target entity name
fields	attachment	comma-separated list of fields provided as a string attachment

Examples

When we read entity Books by selecting the following fields
			"""
			id, name, price
			"""

---

<inner> When we read entity {word} by selecting {word} and {word}

Description

Performs a read request targeting the specified entity and obtaining only the requested two fields

Parameters

Name	Type	Description
entity	word	target entity name
fieldName1	word	first target field
fieldName2	word	second target field

Examples

When we read entity Books by selecting name and price

---

<inner> When we read entity {word} by selecting {word}

Description

Performs a read request targeting the specified entity and obtaining only the requested field

Parameters

Name	Type	Description
entity	word	target entity name
fieldName	word	target field

Examples

When we read entity Books by selecting title

---

<inner> When we read entity {word} by expanding {word}

Description

Performs a read request targeting the specified entity and expanding the specified association

Parameters

Name	Type	Description
entity	word	target entity name
associationName	word	association to follow

Examples

When we read entity Author by expanding books

---

<inner> When we use the following filter

Description

Appends the specified filter to the WHERE clause of the current query ( see: CDS QL: where )

Parameters

Name	Type	Description
filter	attachment	specified filter provided as a JSON-formatted string attachment

Examples

When we use the following filter
			"""
			[{ "ref": ["id"] }, ">", { "val": 2 }]
			"""

---

<inner> When we want to order ascending by {word}

Description

Appends the specified field to the ORDER BY clause of the current query requesting ascending order of the values

Parameters

Name	Type	Description
field	word	name of the field to use

Examples

When we want to order ascending by {word}

---

<inner> When we want to order descending by {word}

Description

Appends the specified field to the ORDER BY clause of the current query requesting descending order of the values

Parameters

Name	Type	Description
field	word	name of the field to use

Examples

When we want to order descending by {word}

---

<inner> When we want to group by {word}

Description

Appends the specified field to the GROUP BY clause of the current query

Parameters

Name	Type	Description
field	word	name of the field to use when grouping the records

Examples

When we want to group by {word}

---

<inner> When we update the record with the following data

Description

Performs an update of a record identified by the previously stored keys

Parameters

Name	Type	Description
data	attachment	specified the fields with corresponding values as a JSON-formatted string to use in the update operation

Examples

When we update the record with the following data

---

<inner> When we update records by setting {string} to {string} using filter

Description

Performs an update of a field in records matching the specified filter

Parameters

Name	Type	Description
field	string	name of the field to update
value	string	value update the field with
filter	attachment	JSON-formatted string used to identify the target records

Examples

When we update records by setting {string} to {string} using filter

---

<inner> When we delete the record from entity {word}

Description

Deletes record identified by the previously stored keys located in the target entity

Parameters

Name	Type	Description
entity	word	target entity name

Examples

When we delete the record from entity {word}

---

<inner> When we delete matching records from entity {word}

Description

Deletes the records located in the target entity and matching filter provided as JSON-formatted string

Parameters

Name	Type	Description
entity	word	target entity name
filter	attachment	JSON-formatted string specifying the filter to use

Examples

When we delete matching records from entity {word}

---

<inner> When we delete the records

Description

Delete previously selected records using their keys

Examples

When we delete the records

---

<inner> When we delete the record

Description

Delete previously selected record using its key

Examples

When we delete the record

---

<inner> Then read all records in entity {word}

Description

Obtain a list of all records in an entity by selecting their IDs

Parameters

Name	Type	Description
entity	word	target entity name

Examples

Then read all records in entity Books

---

<inner> Then show result keys

Description

Prints the current results keys on the console

Examples

Then show result keys

---

<inner> Then show the result

Description

Prints the current result on the console

Examples

Then show the result

---

<inner> When we read {word} of entity {word} with key {int}

Description

Selects the associated records of record with the specified key the target entity

Parameters

Name	Type	Description
association	word	name of the association to follow
entity	word	target entity name
key	int	key of the target record

Examples

When we read auhtor of entity Books with key 1001