Skip to content

class Athena::ORM::Mapping::JoinColumn
inherits Reference #

A column holding a foreign key, as configured by AORMA::JoinColumn or AORMA::InverseJoinColumn.

Join columns are the AORM::Mapping::ToOneOwningSide#join_columns of a to-one association, or the columns of the AORM::Mapping::JoinTable of a many-to-many association.

Methods#

#column_definition : String | ::Nil#

A custom SQL column definition.

Todo

Not set from the mapping yet, and has no effect.

View source

#column_definition=(column_definition : String | Nil)#

A custom SQL column definition.

Todo

Not set from the mapping yet, and has no effect.

View source

#deferrable : Bool | ::Nil#

Whether the foreign key constraint is deferrable.

Todo

Not set from the mapping yet, and has no effect.

View source

#deferrable=(deferrable : Bool | Nil)#

Whether the foreign key constraint is deferrable.

Todo

Not set from the mapping yet, and has no effect.

View source

#name : String#

The name of the column holding the foreign key.

View source

#name=(name : String)#

The name of the column holding the foreign key.

View source

#nullable : Bool | ::Nil#

Whether the column allows NULL.

View source

#nullable=(nullable : Bool | Nil)#

Whether the column allows NULL.

View source

#on_delete : String | ::Nil#

The ON DELETE action of the foreign key constraint, as set by the on_delete argument of AORMA::JoinColumn or AORMA::InverseJoinColumn. Default many-to-many join columns are "CASCADE", see AORM::Mapping::Association#on_delete_cascade?.

View source

#on_delete=(on_delete : String | Nil)#

The ON DELETE action of the foreign key constraint, as set by the on_delete argument of AORMA::JoinColumn or AORMA::InverseJoinColumn. Default many-to-many join columns are "CASCADE", see AORM::Mapping::Association#on_delete_cascade?.

View source

#quoted : Bool | ::Nil#

Whether the names were wrapped in backticks in the mapping, so they're quoted in the generated SQL.

View source

#quoted=(quoted : Bool | Nil)#

Whether the names were wrapped in backticks in the mapping, so they're quoted in the generated SQL.

View source

#referenced_column_name : String#

The name of the column the foreign key references.

View source

#referenced_column_name=(referenced_column_name : String)#

The name of the column the foreign key references.

View source

#unique : Bool | ::Nil#

Whether the column only allows unique values.

View source

#unique=(unique : Bool | Nil)#

Whether the column only allows unique values.

View source