QCassandraContext.h

Go to the documentation of this file.

/*
 * Header:
 *      QCassandraContext.h
 *
 * Description:
 *      Handling of the cassandra::KsDef.
 *
 * Documentation:
 *      See the corresponding .cpp file.
 *
 * License:
 *      Copyright (c) 2011 Made to Order Software Corp.
 * 
 *      http://snapwebsites.org/
 *      contact@m2osw.com
 * 
 *      Permission is hereby granted, free of charge, to any person obtaining a
 *      copy of this software and associated documentation files (the
 *      "Software"), to deal in the Software without restriction, including
 *      without limitation the rights to use, copy, modify, merge, publish,
 *      distribute, sublicense, and/or sell copies of the Software, and to
 *      permit persons to whom the Software is furnished to do so, subject to
 *      the following conditions:
 *
 *      The above copyright notice and this permission notice shall be included
 *      in all copies or substantial portions of the Software.
 *
 *      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *      OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *      MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *      IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *      CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *      TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 *      SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef QCASSANDRA_CONTEXT_H
#define QCASSANDRA_CONTEXT_H

#include "QCassandraTable.h"
#include "QCassandraColumnPredicate.h"

namespace QtCassandra
{

class QCassandraContextPrivate;
class QCassandra;

// Cassandra KsDef object
class QCassandraContext : public QObject
{
public:
    typedef QMap<QString, QString>      QCassandraContextOptions;

    virtual ~QCassandraContext();

    QString contextName() const;

    void setStrategyClass(const QString& strategy_class);
    QString strategyClass() const;

    void setDescriptionOptions(const QCassandraContextOptions& options);
    const QCassandraContextOptions& descriptionOptions() const;
    void setDescriptionOption(const QString& option, const QString& value);
    QString descriptionOption(const QString& option) const;

    // tables
    QSharedPointer<QCassandraTable> table(const QString& table_name);
    const QCassandraTables& tables() const;

    QSharedPointer<QCassandraTable> findTable(const QString& table_name) const;
    QCassandraTable& operator[] (const QString& table_name);
    const QCassandraTable& operator[] (const QString& table_name) const;

    // replication
    void setReplicationFactor(int32_t factor);
    void unsetReplicationFactor();
    int32_t replicationFactor() const;
    void setDurableWrites(bool durable_writes);
    void unsetDurableWrites();
    bool durableWrites() const;

    // handling
    void create();
    void update();
    void drop();
    void dropTable(const QString& table_name);
    void clearCache();

private:
    void makeCurrent();
    QCassandraContext(QCassandra *cassandra, const QString& context_name);

    // internal functions
    void parseContextDefinition(const void *data);
    void prepareContextDefinition(void *data) const;
    void createTable(const QCassandraTable *table);
    void updateTable(const QCassandraTable *table);
    void truncateTable(const QCassandraTable *table);
    void insertValue(const QString& table_name, const QByteArray& row_key, const QByteArray& column_key, const QCassandraValue& value);
    void getValue(const QString& table_name, const QByteArray& row_key, const QByteArray& column_key, QCassandraValue& value);
    int32_t getCellCount(const QString& table_name, const QByteArray& row_key, const QCassandraColumnPredicate& column_predicate);
    void getColumnSlice(QCassandraTable& table, const QByteArray& row_key, const QCassandraColumnPredicate& column_predicate);
    void remove(const QString& table_name, const QByteArray& row_key, const QByteArray& column_key, int64_t timestamp, consistency_level_t consistency_level);
    uint32_t getRowSlices(QCassandraTable& table, const QCassandraRowPredicate& row_predicate);
    void unparent();

    friend class QCassandra;
    friend class QCassandraPrivate;
    friend class QCassandraContextPrivate;
    friend class QCassandraTable;

    std::auto_ptr<QCassandraContextPrivate>     f_private;
    // f_cassandra is a parent that has a strong shared pointer over us so it
    // cannot disappear before we do, thus only a bare pointer is enough here
    // (there isn't a need to use a QWeakPointer or QPointer either)
    QCassandra *                                f_cassandra;
    QCassandraContextOptions                    f_options;
    QCassandraTables                            f_tables;
};

typedef QMap<QString, QSharedPointer<QCassandraContext> > QCassandraContexts;


} // namespace QtCassandra
#endif
//#ifndef QCASSANDRA_CONTEXT_H
// vim: ts=4 sw=4 et