HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_ORMContentType::Meta Class Reference

#include <UT_ORMContentType.h>

+ Inheritance diagram for UT_ORMContentType::Meta:

Public Types

using primary_key_t = int
 

Public Member Functions

 Meta ()
 
void doBuild () override
 
void doPostMigrate () override
 
void collectMigrations (UT_ORMMigrationBuilder &builder) const override
 
- Public Member Functions inherited from UT_ORMModelMeta
 UT_ORMModelMeta (const UT_StringHolder &name, UT_SqlOrm *orm=nullptr)
 
 UT_ORMModelMeta ()
 
virtual ~UT_ORMModelMeta ()=default
 
 UT_NON_COPYABLE (UT_ORMModelMeta)
 
void setTableName (const UT_StringHolder &name)
 
void setModelName (const UT_StringHolder &name)
 
void setVerboseName (const UT_StringHolder &name)
 
void setPluralVerboseName (const UT_StringHolder &name)
 
void build (UT_SqlOrm &orm)
 Call to build out all of your meta information. More...
 
void connectLinks ()
 Called after all models concrete information has been connected. More...
 
virtual void preConnectLinks ()
 Called right before connecting the links on each model. More...
 
void postMigrate ()
 
template<typename Cls , typename FieldT >
void addAutoField (const UT_StringHolder &name, FieldT Cls::*field, unsigned props=UT_ORMColumn::Empty)
 
template<typename Cls , typename FieldT >
void addField (const UT_StringHolder &name, FieldT Cls::*field, unsigned props=UT_ORMColumn::Empty)
 
template<typename Cls , typename ForeignModel >
void addField (const UT_StringHolder &name, UT_ORMForeignKeyField< ForeignModel > Cls::*field, unsigned props=UT_ORMColumn::Empty, UT_ORMColumn::OnDelete ondelete_type=UT_ORMColumn::OnDelete::Cascade, const UT_StringHolder &related_name=UT_StringHolder::theEmptyString, const UT_ORMModelMeta &foreign_meta=ForeignModel::metaInfo())
 
template<typename Owner , typename OtherModel >
void addField (const UT_StringHolder &name, UT_ORMManyToManyField< Owner, OtherModel > Owner::*field, const UT_StringHolder &related_name=UT_StringHolder::theEmptyString)
 
const UT_StringHoldertableName () const
 
const UT_StringHoldermodelName () const
 
const UT_StringHolderverboseName () const
 
const UT_StringHolderpluralVerboseName () const
 
const UT_ORMFieldColumnprimaryKey () const
 
const UT_Array
< UT_ORMFieldColumn > & 
columns () const
 
const UT_Array< const
UT_ORMFieldColumn * > & 
foreignKeys () const
 
const UT_Array< const
UT_ORMFieldColumn * > & 
uniqueColumns () const
 
template<typename T >
bool save (T &obj, UT_ErrorCode &ec, bool force_insert=false, bool force_update=false) const
 
template<typename T >
void remove (T &obj, UT_ErrorCode &ec) const
 
template<typename T >
void remove (const std::initializer_list< UT::orm::FilterArg > &args, UT_ErrorCode &ec) const
 
template<typename T , typename PK >
UT_Optional< Tfetch (const PK &pk, UT_ErrorCode &ec) const
 
template<typename T >
UT_Array< Tfetch (const std::initializer_list< UT::orm::FilterArg > &args, UT_ErrorCode &ec) const
 
template<typename T >
UT_Array< TfetchAll (UT_ErrorCode &ec) const
 
template<typename T >
UT_Optional< Tfilter (const std::initializer_list< UT::orm::FilterArg > &args, UT_ErrorCode &ec) const
 
template<typename T >
std::pair< T, bool > getOrCreate (const std::initializer_list< UT::orm::FilterArg > &args, UT_ErrorCode &ec) const
 
template<typename T >
UT_Optional< Tcreate (const std::initializer_list< UT::orm::FilterArg > &args, UT_ErrorCode &ec) const
 
template<typename T , typename ArrayT >
UT_Array< TbulkFetch (const ArrayT &pks, UT_ErrorCode &ec, const UT_StringRef &col_name=UT_StringHolder::theEmptyString) const
 
template<typename T >
void bulkSave (const UT_Array< T > &items, UT_ErrorCode &ec) const
 
template<typename T , typename... Args>
T fromDB (Args &&...args) const
 
template<typename T >
bool exists (const std::initializer_list< UT::orm::FilterArg > &args, UT_ErrorCode &ec) const
 
UT_SqlOrmorm () const
 
UT_SqlStatement cursor () const
 
UT_SqlDatabasedb ()
 
UT_SqlDatabasedb () const
 
template<typename T >
bool loadObject (T &obj, UT_SqlStatement &stmt, UT_ErrorCode &ec) const
 
template<typename T >
UT_Array< TloadAllObjects (UT_SqlStatement &stmt, UT_ErrorCode &ec)
 
void resetInternals ()
 
bool hasField (const UT_StringView &name) const
 
const UT_ORMFieldColumnfindField (const UT_StringView &name) const
 
const UT_ORMFieldColumnfindForeignRelatedField (const UT_StringView &name) const
 
bool registerRelated (const UT_SharedPtr< UT_ORMModelMeta > &related, const UT_StringHolder &related_name, const UT_StringHolder &fk_field_name=UT_StringHolder::theEmptyString)
 
UT_SharedPtr< UT_ORMModelMetafindRelated (const UT_StringView &name, UT_StringHolder &fk_field_name) const
 
void lookupTableColumns (const UT_StringRef &model_name, const UT_ORMFieldColumn *&fk_model, const UT_ORMFieldColumn *&fk_other_model) const
 
bool isThroughTable () const
 
UT_ORMQuerySet querySet () const
 

Additional Inherited Members

- Protected Member Functions inherited from UT_ORMModelMeta
virtual void doPostBuild ()
 
void configureConcrete_ ()
 Configure any cacheable information that is used often. More...
 
void registerM2M_ (const UT_SharedPtr< UT_ORMModelMeta > &left, const UT_SharedPtr< UT_ORMModelMeta > &right, const UT_StringHolder &field_name, const UT_StringHolder &related_name)
 
UT_SharedPtr< UT_ORMModelMetalookupMetaFromORM_ (const UT_StringView &name) const
 
template<typename T >
bool doUpdate_ (T &obj, UT_ErrorCode &ec) const
 
template<typename T >
bool doInsert_ (T &obj, UT_ErrorCode &ec) const
 
- Static Protected Member Functions inherited from UT_ORMModelMeta
static void addDynamicColumn_ (UT_ORMModelMeta &meta, UT_ORMFieldColumn &&field)
 
- Protected Attributes inherited from UT_ORMModelMeta
bool myHasBuilt = false
 
bool myHasPostBuilt = false
 
bool myHasPostMigrate = false
 
bool myIsThroughTable = false
 
UT_StringHolder myTableName
 
UT_StringHolder myModelName
 
UT_StringHolder myVerboseName
 
UT_StringHolder myPluralVerboseName
 
const UT_ORMFieldColumnmyPrimaryKey = nullptr
 
UT_Array< const
UT_ORMFieldColumn * > 
myForeignKeys
 
UT_Array< const
UT_ORMFieldColumn * > 
myUniqueColumns
 
UT_Array< UT_ORMFieldColumnmyColumns
 
UT_Array< RelatedmyRelated
 
UT_SqlOrmmyORM = nullptr
 

Detailed Description

Definition at line 32 of file UT_ORMContentType.h.

Member Typedef Documentation

Constructor & Destructor Documentation

UT_ORMContentType::Meta::Meta ( )
inline

Definition at line 37 of file UT_ORMContentType.h.

Member Function Documentation

void UT_ORMContentType::Meta::collectMigrations ( UT_ORMMigrationBuilder builder) const
overridevirtual

Implements UT_ORMModelMeta.

void UT_ORMContentType::Meta::doBuild ( )
overridevirtual

Implements UT_ORMModelMeta.

void UT_ORMContentType::Meta::doPostMigrate ( )
overridevirtual

Reimplemented from UT_ORMModelMeta.


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