ExternalSortExecStream.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/sorter/ExternalSortExecStream.h#2 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2005-2009 The Eigenbase Project
// Copyright (C) 2009-2009 SQLstream, Inc.
// Copyright (C) 2004-2009 LucidEra, Inc.
// Portions Copyright (C) 2004-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_ExternalSortExecStream_Included
#define Fennel_ExternalSortExecStream_Included

#include "fennel/exec/ConduitExecStream.h"
#include "fennel/common/FemEnums.h"
#include "fennel/tuple/TupleDescriptor.h"

#include <vector>

FENNEL_BEGIN_NAMESPACE

struct ExternalSortExecStreamParams : public ConduitExecStreamParams
{
    // TODO:  implement duplicate handling
    Distinctness distinctness;

    SharedSegment pTempSegment;

    TupleProjection keyProj;

    // TODO:  generalized collation support
    std::vector<bool> descendingKeyColumns;

    bool storeFinalRun;

    RecordNum estimatedNumRows;

    bool earlyClose;
};

class FENNEL_SORTER_EXPORT ExternalSortExecStream
    : public ConduitExecStream
{
public:
    static ExternalSortExecStream *newExternalSortExecStream();

    // implement ExecStream
    virtual void prepare(ExternalSortExecStreamParams const &params) = 0;
};

FENNEL_END_NAMESPACE

#endif

// End ExternalSortExecStream.h

---