QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Protected Attributes | List of all members
QgsSQLStatement::NodeTableDef Class Reference

Table definition. More...

#include <qgssqlstatement.h>

Inheritance diagram for QgsSQLStatement::NodeTableDef:
Inheritance graph
[legend]

Public Member Functions

 NodeTableDef (const QString &name)
 Constructor with table name. More...
 
 NodeTableDef (const QString &name, const QString &alias)
 Constructor with table name and alias. More...
 
 NodeTableDef (const QString &schema, const QString &name, const QString &alias)
 Constructor with schema, table name and alias. More...
 
void accept (QgsSQLStatement::Visitor &v) const override
 Support the visitor pattern. More...
 
QString alias () const
 Table alias. More...
 
QgsSQLStatement::Nodeclone () const override
 Generate a clone of this node. More...
 
QgsSQLStatement::NodeTableDefcloneThis () const
 Clone with same type return. More...
 
QString dump () const override
 Abstract virtual dump method. More...
 
QString name () const
 Table name. More...
 
QgsSQLStatement::NodeType nodeType () const override
 Abstract virtual that returns the type of this node. More...
 
QString schema () const
 Returns the schema name. More...
 
- Public Member Functions inherited from QgsSQLStatement::Node
virtual ~Node ()=default
 
virtual void accept (QgsSQLStatement::Visitor &v) const =0
 Support the visitor pattern. More...
 
virtual QgsSQLStatement::Nodeclone () const =0
 Generate a clone of this node. More...
 
virtual QString dump () const =0
 Abstract virtual dump method. More...
 
virtual QgsSQLStatement::NodeType nodeType () const =0
 Abstract virtual that returns the type of this node. More...
 

Protected Attributes

QString mAlias
 
QString mName
 
QString mSchema
 

Detailed Description

Table definition.

Definition at line 623 of file qgssqlstatement.h.

Constructor & Destructor Documentation

◆ NodeTableDef() [1/3]

QgsSQLStatement::NodeTableDef::NodeTableDef ( const QString &  name)
inline

Constructor with table name.

Definition at line 627 of file qgssqlstatement.h.

◆ NodeTableDef() [2/3]

QgsSQLStatement::NodeTableDef::NodeTableDef ( const QString &  name,
const QString &  alias 
)
inline

Constructor with table name and alias.

Definition at line 629 of file qgssqlstatement.h.

◆ NodeTableDef() [3/3]

QgsSQLStatement::NodeTableDef::NodeTableDef ( const QString &  schema,
const QString &  name,
const QString &  alias 
)
inline

Constructor with schema, table name and alias.

Since
QGIS 3.28

Definition at line 635 of file qgssqlstatement.h.

Member Function Documentation

◆ accept()

void QgsSQLStatement::NodeTableDef::accept ( QgsSQLStatement::Visitor v) const
inlineoverridevirtual

Support the visitor pattern.

For any implementation this should look like

C++:

v.visit( *this );

Python:

v.visit( self)
Parameters
vA visitor that visits this node.

Implements QgsSQLStatement::Node.

Definition at line 653 of file qgssqlstatement.h.

◆ alias()

QString QgsSQLStatement::NodeTableDef::alias ( ) const
inline

Table alias.

Definition at line 648 of file qgssqlstatement.h.

◆ clone()

QgsSQLStatement::Node * QgsSQLStatement::NodeTableDef::clone ( ) const
overridevirtual

Generate a clone of this node.

Make sure that the clone does not contain any information which is generated in prepare and context related. Ownership is transferred to the caller.

Returns
a deep copy of this node.

Implements QgsSQLStatement::Node.

Definition at line 585 of file qgssqlstatement.cpp.

◆ cloneThis()

QgsSQLStatement::NodeTableDef * QgsSQLStatement::NodeTableDef::cloneThis ( ) const

Clone with same type return.

Definition at line 580 of file qgssqlstatement.cpp.

◆ dump()

QString QgsSQLStatement::NodeTableDef::dump ( ) const
overridevirtual

Abstract virtual dump method.

Returns
A statement which represents this node as string

Implements QgsSQLStatement::Node.

Definition at line 565 of file qgssqlstatement.cpp.

◆ name()

QString QgsSQLStatement::NodeTableDef::name ( ) const
inline

Table name.

Definition at line 638 of file qgssqlstatement.h.

◆ nodeType()

QgsSQLStatement::NodeType QgsSQLStatement::NodeTableDef::nodeType ( ) const
inlineoverridevirtual

Abstract virtual that returns the type of this node.

Returns
The type of this node

Implements QgsSQLStatement::Node.

Definition at line 650 of file qgssqlstatement.h.

◆ schema()

QString QgsSQLStatement::NodeTableDef::schema ( ) const
inline

Returns the schema name.

Since
QGIS 3.28

Definition at line 645 of file qgssqlstatement.h.

Member Data Documentation

◆ mAlias

QString QgsSQLStatement::NodeTableDef::mAlias
protected

Definition at line 661 of file qgssqlstatement.h.

◆ mName

QString QgsSQLStatement::NodeTableDef::mName
protected

Definition at line 659 of file qgssqlstatement.h.

◆ mSchema

QString QgsSQLStatement::NodeTableDef::mSchema
protected

Definition at line 660 of file qgssqlstatement.h.


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