Ice 3.7 C++11 API Reference
Loading...
Searching...
No Matches
IceGrid::DbEnvDescriptor Struct Reference

A Freeze database environment descriptor. More...

#include <IceGrid/IceGrid.h>

Public Member Functions

std::tuple< const ::std::string &, const ::std::string &, const ::std::string &, const ::IceGrid::PropertyDescriptorSeq & > ice_tuple () const
 Obtains a tuple containing all of the struct's data members.

Public Attributes

::std::string dbHome
 The home of the database environment (i.e., the directory where the database files will be stored).
::std::string description
 The description of this database environment.
::std::string name
 The name of the database environment.
::IceGrid::PropertyDescriptorSeq properties
 The configuration properties of the database environment.

Detailed Description

A Freeze database environment descriptor.

Member Function Documentation

◆ ice_tuple()

std::tuple< const ::std::string &, const ::std::string &, const ::std::string &, const ::IceGrid::PropertyDescriptorSeq & > IceGrid::DbEnvDescriptor::ice_tuple ( ) const
inline

Obtains a tuple containing all of the struct's data members.

Returns
The data members in a tuple.

Member Data Documentation

◆ dbHome

::std::string IceGrid::DbEnvDescriptor::dbHome

The home of the database environment (i.e., the directory where the database files will be stored).

If empty, the node will provide a default database directory, otherwise the directory must exist.

◆ description

::std::string IceGrid::DbEnvDescriptor::description

The description of this database environment.

◆ name

::std::string IceGrid::DbEnvDescriptor::name

The name of the database environment.

◆ properties

::IceGrid::PropertyDescriptorSeq IceGrid::DbEnvDescriptor::properties

The configuration properties of the database environment.


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