26 #ifndef __TERRALIB_SQLITE_INTERNAL_DATASOURCETRANSACTOR_H
27 #define __TERRALIB_SQLITE_INTERNAL_DATASOURCETRANSACTOR_H
30 #include "../dataaccess/datasource/DataSourceTransactor.h"
62 std::auto_ptr<te::da::DataSet>
getDataSet(
const std::string& name,
64 bool connected =
false,
67 std::auto_ptr<te::da::DataSet>
getDataSet(
const std::string& name,
68 const std::string& propertyName,
72 bool connected =
false,
75 std::auto_ptr<te::da::DataSet>
getDataSet(
const std::string& name,
76 const std::string& propertyName,
80 bool connected =
false,
85 bool connected =
false,
88 std::auto_ptr<te::da::DataSet>
query(
const std::string& query,
90 bool connected =
false,
95 void execute(
const std::string& command);
97 std::auto_ptr<te::da::PreparedQuery>
getPrepared(
const std::string& qName = std::string(
""));
105 std::string
escape(
const std::string& value);
115 std::auto_ptr<te::da::DataSetType>
getDataSetType(
const std::string& name);
117 boost::ptr_vector<te::dt::Property>
getProperties(
const std::string& datasetName);
119 std::auto_ptr<te::dt::Property>
getProperty(
const std::string& datasetName,
const std::string& name);
121 std::auto_ptr<te::dt::Property>
getProperty(
const std::string& datasetName, std::size_t propertyPos);
127 bool propertyExists(
const std::string& datasetName,
const std::string& name);
131 void dropProperty(
const std::string& datasetName,
const std::string& name);
134 const std::string& propertyName,
135 const std::string& newPropertyName);
137 std::auto_ptr<te::da::PrimaryKey>
getPrimaryKey(
const std::string& datasetName);
139 bool primaryKeyExists(
const std::string& datasetName,
const std::string& name);
145 std::auto_ptr<te::da::ForeignKey>
getForeignKey(
const std::string& datasetName,
const std::string& name);
149 bool foreignKeyExists(
const std::string& datasetName,
const std::string& name);
153 void dropForeignKey(
const std::string& datasetName,
const std::string& fkName);
155 std::auto_ptr<te::da::UniqueKey>
getUniqueKey(
const std::string& datasetName,
const std::string& name);
159 bool uniqueKeyExists(
const std::string& datasetName,
const std::string& name);
163 void dropUniqueKey(
const std::string& datasetName,
const std::string& name);
165 std::auto_ptr<te::da::CheckConstraint>
getCheckConstraint(
const std::string& datasetName,
const std::string& name);
175 std::auto_ptr<te::da::Index>
getIndex(
const std::string& datasetName,
const std::string& name);
177 std::vector<std::string>
getIndexNames(
const std::string& datasetName);
179 bool indexExists(
const std::string& datasetName,
const std::string& name);
181 void addIndex(
const std::string& datasetName,
183 const std::map<std::string, std::string>& options);
185 void dropIndex(
const std::string& datasetName,
const std::string& idxName);
187 std::auto_ptr<te::da::Sequence>
getSequence(
const std::string& name);
197 std::auto_ptr<te::gm::Envelope>
getExtent(
const std::string& datasetName,
198 const std::string& propertyName);
200 std::auto_ptr<te::gm::Envelope>
getExtent(
const std::string& datasetName,
201 std::size_t propertyPos);
212 const std::string& cloneName,
213 const std::map<std::string, std::string>& options);
217 void renameDataSet(
const std::string& name,
const std::string& newName);
219 void add(
const std::string& datasetName,
221 const std::map<std::string, std::string>& options,
222 std::size_t limit = 0);
226 void update(
const std::string& datasetName,
228 const std::vector<std::size_t>& properties,
230 const std::map<std::string, std::string>& options,
231 std::size_t limit = 0);
233 void optimize(
const std::map<std::string, std::string>& opInfo);
246 #endif // __TERRALIB_SQLITE_INTERNAL_DATASOURCETRANSACTOR_H
std::auto_ptr< te::da::Sequence > getSequence(const std::string &name)
It gets the sequence with the given name in the data source.
void dropProperty(const std::string &datasetName, const std::string &name)
It removes a property from the given dataset.
void addCheckConstraint(const std::string &datasetName, te::da::CheckConstraint *cc)
It adds a check constraint to the dataset.
std::vector< std::string > getDataSetNames()
It It gets the dataset names available in the data source.
void dropUniqueKey(const std::string &datasetName, const std::string &name)
It removes the unique key constraint from the dataset.
void cloneDataSet(const std::string &name, const std::string &cloneName, const std::map< std::string, std::string > &options)
It clones the dataset in the data source.
~DataSourceTransactor()
Virtual destructor.
DataSourceTransactor()
Default constructor that can be called by subclasses.
A class that models the description of a dataset.
std::string escape(const std::string &value)
It escapes a string for using in commands and queries.
bool isDataSetNameValid(const std::string &datasetName)
It returns true if the given string is a valid dataset name.
std::auto_ptr< te::da::DataSet > getDataSet(const std::string &name, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
It gets the dataset identified by the given name. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.
std::auto_ptr< te::da::CheckConstraint > getCheckConstraint(const std::string &datasetName, const std::string &name)
It gets the check constraint of the dataset with the given name.
bool isInTransaction() const
It returns true if a transaction is in progress, otherwise, it returns false.
std::vector< std::string > getUniqueKeyNames(const std::string &datasetName)
It gets the unique key names of the given dataset.
SpatialRelation
Spatial relations between geometric objects.
void addIndex(const std::string &datasetName, te::da::Index *idx, const std::map< std::string, std::string > &options)
It adds an index to the dataset.
It describes a sequence (a number generator).
bool foreignKeyExists(const std::string &datasetName, const std::string &name)
It checks if a foreign key with the given name exists in the data source.
void dropSequence(const std::string &name)
It removes the sequence from the data source.
A class that describes a check constraint.
std::auto_ptr< te::da::UniqueKey > getUniqueKey(const std::string &datasetName, const std::string &name)
It gets the unique key in the dataset with the given name.
An abstract class for data providers like a DBMS, Web Services or a regular file. ...
std::auto_ptr< te::gm::Envelope > getExtent(const std::string &datasetName, const std::string &propertyName)
It retrieves the bounding rectangle of the spatial property for the given dataset.
void dropPrimaryKey(const std::string &datasetName)
It removes the primary key constraint from the dataset schema.
void dropDataSet(const std::string &name)
It removes the dataset schema from the data source.
It models a property definition.
void optimize(const std::map< std::string, std::string > &opInfo)
For some data access drivers, this method will perform some operations to optimize the data storage...
void addProperty(const std::string &datasetName, te::dt::Property *p)
It adds a new property to the dataset schema.
bool propertyExists(const std::string &datasetName, const std::string &name)
It checks if a property with the given name exists in the dataset.
void begin()
It starts a new transaction.
bool indexExists(const std::string &datasetName, const std::string &name)
It checks if an index with the given name exists in the dataset.
AccessPolicy
Supported data access policies (can be used as bitfield).
bool primaryKeyExists(const std::string &datasetName, const std::string &name)
It checks if a primary key exists in the dataset.
TraverseType
A dataset can be traversed in two ways:
void dropForeignKey(const std::string &datasetName, const std::string &fkName)
It removes the foreign key constraint from the dataset schema.
void dropIndex(const std::string &datasetName, const std::string &idxName)
It removes the index from the dataset schema.
void createDataSet(te::da::DataSetType *dt, const std::map< std::string, std::string > &options)
It creates the dataset schema definition in the target data source.
std::auto_ptr< te::da::ForeignKey > getForeignKey(const std::string &datasetName, const std::string &name)
It retrieves the foreign key from the given dataset.
void addPrimaryKey(const std::string &datasetName, te::da::PrimaryKey *pk)
It adds a primary key constraint to the dataset schema.
void renameDataSet(const std::string &name, const std::string &newName)
It renames a dataset.
An Envelope defines a 2D rectangular region.
std::size_t getNumberOfDataSets()
It retrieves the number of data sets available in the data source.
std::vector< std::string > getForeignKeyNames(const std::string &datasetName)
It gets the foreign key names of the given dataset.
This class represents a set of unique ids created in the same context. i.e. from the same data set...
bool checkConstraintExists(const std::string &datasetName, const std::string &name)
It checks if a check-constraint with the given name exists in the data source.
std::auto_ptr< te::da::PrimaryKey > getPrimaryKey(const std::string &datasetName)
It retrieves the primary key of the dataset.
std::auto_ptr< te::da::BatchExecutor > getBatchExecutor()
It creates a batch command executor.
void addSequence(te::da::Sequence *sequence)
It creates a new sequence in the data source.
std::auto_ptr< te::da::Index > getIndex(const std::string &datasetName, const std::string &name)
It gets the index with the given name from the dataset.
bool isPropertyNameValid(const std::string &propertyName)
It checks if the given property name is valid.
It models a foreign key constraint for a DataSetType.
std::auto_ptr< te::dt::Property > getProperty(const std::string &datasetName, const std::string &name)
It retrieves the property with the given name from the dataset.
bool hasDataSets()
It checks if the data source has any dataset.
bool sequenceExists(const std::string &name)
It checks if a sequence with the given name exists in the data source.
It describes a unique key (uk) constraint.
A DataSourceTransactor can be viewed as a connection to the data source for reading/writing things in...
std::size_t getNumberOfProperties(const std::string &datasetName)
It gets the number of properties of the given dataset.
te::da::DataSource * getDataSource() const
It returns the parent data source of the transactor.
void execute(const te::da::Query &command)
It executes the specified command using a generic query representation.
std::size_t getNumberOfItems(const std::string &datasetName)
It retrieves the number of items of the given dataset.
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
std::vector< std::string > getCheckConstraintNames(const std::string &datasetName)
It gets the check constraint names of the given dataset.
A Select models a query to be used when retrieving data from a DataSource.
boost::int64_t getLastGeneratedId()
It returns the last id generated by an insertion command.
A dataset is the unit of information manipulated by the data access module of TerraLib.
void addForeignKey(const std::string &datasetName, te::da::ForeignKey *fk)
It adds a foreign key constraint to a dataset.
std::vector< std::string > getIndexNames(const std::string &datasetName)
It gets the index names of the given dataset.
std::auto_ptr< te::da::DataSetType > getDataSetType(const std::string &name)
It gets information about the given dataset.
It describes a primary key (pk) constraint.
void dropCheckConstraint(const std::string &datasetName, const std::string &name)
It removes the check constraint from the dataset.
void renameProperty(const std::string &datasetName, const std::string &propertyName, const std::string &newPropertyName)
It renames a property of the given dataset.
std::auto_ptr< te::da::DataSet > query(const te::da::Select &q, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
It executes a query that may return some data using a generic query. A dataset can be connected or di...
std::auto_ptr< te::da::PreparedQuery > getPrepared(const std::string &qName=std::string(""))
It creates a prepared query object that may be used for query commands (select, insert, update and delete) that are used repeatedly.
void addUniqueKey(const std::string &datasetName, te::da::UniqueKey *uk)
It adds a unique key constraint to the dataset.
void commit()
It commits the transaction.
void update(const std::string &datasetName, te::da::DataSet *dataset, const std::vector< std::size_t > &properties, const te::da::ObjectIdSet *oids, const std::map< std::string, std::string > &options, std::size_t limit=0)
It updates the contents of a dataset for the set of data items.
std::vector< std::string > getPropertyNames(const std::string &datasetName)
It gets the property names of the given dataset.
void rollBack()
It aborts the transaction. Any changes will be rolled-back.
void add(const std::string &datasetName, te::da::DataSet *d, const std::map< std::string, std::string > &options, std::size_t limit=0)
It adds data items to the dataset in the data source.
bool dataSetExists(const std::string &name)
It checks if a dataset with the given name exists in the data source.
void cancel()
It requests that the data source stop the processing of the current command.
bool uniqueKeyExists(const std::string &datasetName, const std::string &name)
It checks if a unique key with the given name exists in the dataset.
std::vector< std::string > getSequenceNames()
It gets the sequence names available in the data source.
A Query is independent from the data source language/dialect.
It describes an index associated to a DataSetType.
boost::ptr_vector< te::dt::Property > getProperties(const std::string &datasetName)
It retrieves the properties of the dataset.