LhxHashBase.h

Go to the documentation of this file.

/*
// $Id: //open/dev/fennel/hashexe/LhxHashBase.h#1 $
// Fennel is a library of data storage and processing components.
// Copyright (C) 2006-2009 The Eigenbase Project
// Copyright (C) 2009-2009 SQLstream, Inc.
// Copyright (C) 2006-2009 LucidEra, Inc.
//
// 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_LhxHashBase_Included
#define Fennel_LhxHashBase_Included

#include "fennel/segment/SegmentAccessor.h"

using namespace std;

// REVIEW jvs 25-Aug-2006:  This file should be named LhxHashInfo.h, right?

FENNEL_BEGIN_NAMESPACE

enum LhxHashTrim
{
    HASH_TRIM_NONE,
    HASH_TRIM_VARCHAR,
    HASH_TRIM_UNICODE_VARCHAR
};

struct LhxHashInfo
{
    // REVIEW jvs 25-Aug-2006:  This shouldn't be a doxygen comment since
    // it's not associated with any field.  Seems like the second sentence
    // is out-of-date.
    SegmentAccessor externalSegmentAccessor;

    SegmentAccessor memSegmentAccessor;

    uint numCachePages;

    // REVIEW jvs 25-Aug-2006:  Instead of ten vectors of types, it's
    // cleaner to create one struct (say LhxHashInputInfo) containing
    // all the types as fields, and then just create one
    // vector<LhxHashInputInfo>.  Access is then info.input[i].useJoinFilter
    // rather than info.useJoinFilter[i].

    // REVIEW jvs 25-Aug-2006:  Why is this named inputDesc?  Isn't
    // it really output?  For example, LhxAggExecStream::prepare
    // sets outputDesc = inputDesc.
    vector<TupleDescriptor> inputDesc;

    vector<TupleProjection> keyProj;

    /*
     * If a key column is varchar type.
     */
    vector< vector<LhxHashTrim> > isKeyColVarChar;

    /*
     * In hash join, if an input can be filtered using bitmap saved from
     * previous round of partitioning.
     */
    vector<bool> useJoinFilter;

    TupleProjection aggsProj;
    vector<TupleProjection> dataProj;

    vector<RecordNum> numRows;

    vector<RecordNum> cndKeys;

    vector<SharedExecStreamBufAccessor> streamBufAccessor;

    vector<bool> filterNull;
    vector<TupleProjection> filterNullKeyProj;
    vector<bool> removeDuplicate;
};

FENNEL_END_NAMESPACE

#endif

// End LhxHashBase.h

---