mapping | ScyllaDB Docs

mapping¶

Module containing classes and fields related to the Mapper.

Source

Classes¶

Members¶

Contains functions that represents operators in a query.

Name	Type	Description
`in_`	function	Represents the CQL operator "IN".
`gt`	function	Represents the CQL operator greater than ">".
`gte`	function	Represents the CQL operator greater than or equals to ">=" .
`lt`	function	Represents the CQL operator less than "<" .
`lte`	function	Represents the CQL operator less than or equals to "<=" .
`notEq`	function	Represents the CQL operator not equals to "!=" .
`and`	function	When applied to a property, it represents two CQL conditions on the same column separated by the logical AND operator, e.g: "col1 >= x col < y"
`incr`	function	Represents the CQL increment assignment used for counters, e.g: "col = col + x"
`decr`	function	Represents the CQL decrement assignment used for counters, e.g: "col = col - x"
`append`	function	Represents the CQL append assignment used for collections, e.g: "col = col + x"
`prepend`	function	Represents the CQL prepend assignment used for lists, e.g: "col = x + col"
`remove`	function	Represents the CQL remove assignment used for collections, e.g: "col = col - x"

Source

Represents the mapping options.

Name	Type	Description
`models`	Object:.<String:, ModelOptions:>	An associative array containing the name of the model as key and the table and column information as value.

Source

Represents a set of options that applies to a certain model.

Name	Type	Attributes	Description
`tables`	Array:.<String:> \| Array:.<{name:, isView:}>		An Array containing the name of the tables or An Array containing the name and isView property to describe the table.
`mappings`	TableMappings		The TableMappings implementation instance that is used to convert from column names to property names and the other way around.
`columnNames`	Object:.<String:, String:>	<optional>	An associative array containing the name of the columns and properties that doesn't follow the convention defined in the `TableMappings`.
`keyspace`	String	<optional>	The name of the keyspace. Only mandatory when the Client is not using a keyspace.

Source

Was this page helpful?