relx 0.1.0
A Modern C++23 Type-Safe SQL Query Builder
Loading...
Searching...
No Matches
relx::schema::foreign_key< LocalColumnPtr, ReferencedColumnPtr > Class Template Reference

Represents a foreign key constraint on a table. More...

#include <relx/schema/foreign_key.hpp>

Public Member Functions

 foreign_key ()
 Default constructor.
 
 foreign_key (reference_action on_delete, reference_action on_update)
 Constructor with custom actions.
 
std::string sql_definition () const
 Get SQL definition for the FOREIGN KEY constraint.
 

Detailed Description

template<auto LocalColumnPtr, auto ReferencedColumnPtr>
class relx::schema::foreign_key< LocalColumnPtr, ReferencedColumnPtr >

Represents a foreign key constraint on a table.

Template Parameters
LocalColumnPtrPointer to the local column
ReferencedColumnPtrPointer to the referenced column

Definition at line 42 of file foreign_key.hpp.

Constructor & Destructor Documentation

◆ foreign_key() [1/2]

template<auto LocalColumnPtr, auto ReferencedColumnPtr>
relx::schema::foreign_key< LocalColumnPtr, ReferencedColumnPtr >::foreign_key ( )
inline

Default constructor.

Definition at line 45 of file foreign_key.hpp.

◆ foreign_key() [2/2]

template<auto LocalColumnPtr, auto ReferencedColumnPtr>
relx::schema::foreign_key< LocalColumnPtr, ReferencedColumnPtr >::foreign_key ( reference_action  on_delete,
reference_action  on_update 
)
inline

Constructor with custom actions.

Parameters
on_deleteAction on delete
on_updateAction on update

Definition at line 51 of file foreign_key.hpp.

Member Function Documentation

◆ sql_definition()

template<auto LocalColumnPtr, auto ReferencedColumnPtr>
std::string relx::schema::foreign_key< LocalColumnPtr, ReferencedColumnPtr >::sql_definition ( ) const
inline

Get SQL definition for the FOREIGN KEY constraint.

Returns
SQL string defining the constraint

Definition at line 56 of file foreign_key.hpp.


The documentation for this class was generated from the following file: