FtrsTableWriter.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/ftrs/FtrsTableWriter.h#10 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2003-2009 SQLstream, Inc.
// Copyright (C) 2005-2009 LucidEra, Inc.
// Portions Copyright (C) 1999-2009 John V. Sichi
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2 of the License, or (at your option)
// any later version approved by The Eigenbase Project.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef Fennel_FtrsTableWriter_Included
#define Fennel_FtrsTableWriter_Included

#include "fennel/ftrs/BTreeInsertExecStream.h"
#include "fennel/txn/LogicalTxnParticipant.h"
#include <boost/scoped_array.hpp>

FENNEL_BEGIN_NAMESPACE

class SXMutex;

struct FENNEL_FTRS_EXPORT FtrsTableIndexWriterParams
    : public BTreeInsertExecStreamParams
{
    TupleProjection inputProj;

    bool updateInPlace;
};

struct FENNEL_FTRS_EXPORT FtrsTableWriterParams
    : public ConduitExecStreamParams
{
    std::vector<FtrsTableIndexWriterParams> indexParams;

    PageOwnerId tableId;

    TupleProjection updateProj;
};

struct FENNEL_FTRS_EXPORT FtrsTableIndexWriter
{
    SharedBTreeWriter pWriter;
    Distinctness distinctness;
    TupleProjection inputProj;
    TupleProjection inputKeyProj;
    TupleData tupleData;
    BTreeOwnerRootMap *pRootMap;
    bool updateInPlace;
};

class FENNEL_FTRS_EXPORT FtrsTableWriter
    : public LogicalTxnParticipant
{
    friend class FtrsTableWriterFactory;

    typedef std::vector<FtrsTableIndexWriter> IndexWriterVector;

    uint nAttrs;
    TupleAccessor tupleAccessor;
    IndexWriterVector indexWriters;
    FtrsTableIndexWriter *pClusteredIndexWriter;
    TupleProjection updateProj;
    TupleData updateTupleData;
    TupleData *pTupleData;
    boost::scoped_array<FixedBuffer> logBuf;

    FtrsTableIndexWriter &createIndexWriter(
        FtrsTableIndexWriter &,
        FtrsTableIndexWriterParams const &);
    inline void insertIntoIndex(FtrsTableIndexWriter &);
    inline void deleteFromIndex(FtrsTableIndexWriter &);
    void describeIndex(FtrsTableIndexWriter &,ByteOutputStream *pLogStream);
    void executeUpdate(bool reverse);
    inline void modifyAllIndexes(LogicalActionType);
    inline void modifySomeIndexes(
        LogicalActionType,
        IndexWriterVector::iterator &,
        IndexWriterVector::iterator);
    inline void executeTuple(LogicalActionType);
    inline void copyNewValues();
    inline void copyOldValues();
    inline bool searchForIndexKey(FtrsTableIndexWriter &);

    explicit FtrsTableWriter(FtrsTableWriterParams const &params);
    PageOwnerId getTableId();

public:
    static const LogicalActionType ACTION_INSERT;

    static const LogicalActionType ACTION_DELETE;

    static const LogicalActionType ACTION_UPDATE;

    static const LogicalActionType ACTION_REVERSE_UPDATE;

    RecordNum execute(
        ExecStreamQuantum const &quantum,
        ExecStreamBufAccessor &bufAccessor,
        LogicalActionType actionType,
        SXMutex &actionMutex);

    uint getIndexCount() const;
    void openIndexWriters();
    void closeIndexWriters();

    // implement LogicalTxnParticipant
    virtual LogicalTxnClassId getParticipantClassId() const;
    virtual void describeParticipant(
        ByteOutputStream &logStream);
    virtual void undoLogicalAction(
        LogicalActionType actionType,
        ByteInputStream &logStream);
    virtual void redoLogicalAction(
        LogicalActionType actionType,
        ByteInputStream &logStream);

};

FENNEL_END_NAMESPACE

#endif

// End FtrsTableWriter.h

---