duckdb::StatementProperties Struct Reference

A struct containing various properties of a SQL statement. More...

Collaboration diagram for duckdb::StatementProperties:

Classes
struct	CatalogIdentity
struct	ModificationInfo

Public Member Functions
bool	IsReadOnly ()
void	RegisterDBRead (Catalog &catalog, ClientContext &context)
void	RegisterDBModify (Catalog &catalog, ClientContext &context, DatabaseModificationType modification)

Public Attributes
unordered_map< string, CatalogIdentity >	read_databases
	The set of databases this statement will read from.
unordered_map< string, ModificationInfo >	modified_databases
	The set of databases this statement will modify.
bool	requires_valid_transaction
QueryResultOutputType	output_type
	Whether or not the result can be streamed to the client.
bool	bound_all_parameters
	Whether or not all parameters have successfully had their types determined.
StatementReturnType	return_type
	What type of data the statement returns.
idx_t	parameter_count
	The number of prepared statement parameters.
bool	always_require_rebind
	Whether or not the statement ALWAYS requires a rebind.

Detailed Description

A struct containing various properties of a SQL statement.

Constructor & Destructor Documentation

StatementProperties()

duckdb::StatementProperties::StatementProperties ( )

inline

        : requires_valid_transaction(true), output_type(QueryResultOutputType::FORCE_MATERIALIZED),
          bound_all_parameters(true), return_type(StatementReturnType::QUERY_RESULT), parameter_count(0),
          always_require_rebind(false) {
    }

Member Function Documentation

IsReadOnly()

bool duckdb::StatementProperties::IsReadOnly ( )

inline

                      {
        return modified_databases.empty();
    }

RegisterDBRead()

void duckdb::StatementProperties::RegisterDBRead	(	Catalog &	catalog,
		ClientContext &	context
	)

                                                                                 {
    auto catalog_identity = CatalogIdentity {catalog.GetOid(), catalog.GetCatalogVersion(context)};
    D_ASSERT(read_databases.count(catalog.GetName()) == 0 || read_databases[catalog.GetName()] == catalog_identity);
    read_databases[catalog.GetName()] = catalog_identity;
}

RegisterDBModify()

void duckdb::StatementProperties::RegisterDBModify	(	Catalog &	catalog,
		ClientContext &	context,
		DatabaseModificationType	modification
	)

                                                                                  {
    auto catalog_identity = CatalogIdentity {catalog.GetOid(), catalog.GetCatalogVersion(context)};
    auto entry = modified_databases.insert(make_pair(catalog.GetName(), ModificationInfo()));
    if (entry.second) {
        // new entry - set the identity
        entry.first->second.identity = catalog_identity;
    } else {
        // existing entry - verify this has the same identity
        D_ASSERT(entry.first->second.identity == catalog_identity);
    }
    entry.first->second.modifications |= modification;
}

Member Data Documentation

requires_valid_transaction

bool duckdb::StatementProperties::requires_valid_transaction

Whether or not the statement requires a valid transaction. Almost all statements require this, with the exception of ROLLBACK

---

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

• external/duckdb/duckdb.hpp
• external/duckdb/duckdb.cpp