TupleDescriptor Class Reference

A TupleDescriptor specifies a vector of stored attributes, as explained in the design docs. More...

#include <TupleDescriptor.h>

List of all members.

Public Member Functions
void	projectFrom (TupleDescriptor const &tupleDescriptor, TupleProjection const &tupleProjection)
int	compareTuplesKey (TupleData const &tuple1, TupleData const &tuple2, uint keyCount) const
int	compareTuples (TupleData const &tuple1, TupleData const &tuple2) const
int	compareTuples (TupleData const &tuple1, TupleProjection const &proj1, TupleData const &tuple2, TupleProjection const &proj2, bool *containsNullKey=NULL) const
void	writePersistent (ByteOutputStream &) const
void	readPersistent (ByteInputStream &, StoredTypeDescriptorFactory const &)
void	visit (TupleData const &tuple, DataVisitor &dataVisitor, bool visitLengths) const
bool	containsNullable () const
bool	storageEqual (TupleDescriptor const &other) const
	Performs a comparison only of type & size, not nullability.
TupleStorageByteLength	getMaxByteCount () const

---

Detailed Description

A TupleDescriptor specifies a vector of stored attributes, as explained in the design docs.

The compareTuples[Key] methods return the standard zero, negative, or positive to indicate EQ, LT, GT. However, rather than returning -1 or 1 for LT/GT, they return the 1-based ordinal of the first non-equal column (negated if LT). This allows a caller to implement ORDER BY DESC without having to pass in ASC/DESC information.

Definition at line 89 of file TupleDescriptor.h.

---

Member Function Documentation

void TupleDescriptor::projectFrom	(	TupleDescriptor const &	tupleDescriptor,
		TupleProjection const &	tupleProjection
	)

Definition at line 72 of file TupleDescriptor.cpp.

Referenced by BTreeAccessBase::BTreeAccessBase(), LhxHashTable::calculateSize(), LhxHashKeyAccessor::init(), ReshapeExecStream::initCompareData(), LbmExecStreamTestBase::initNormalizerExecStream(), LcsClusterReplaceExecStream::initTupleLoadParams(), LcsClusterAppendExecStream::initTupleLoadParams(), FtrsTableWriterFactory::loadIndex(), ExternalSortExecStreamImpl::prepare(), LbmNormalizerExecStream::prepare(), LhxJoinExecStream::prepare(), BTreeSearchExecStream::prepare(), ReshapeExecStream::prepare(), LcsRowScanExecStream::prepareResidualFilters(), LhxAggExecStream::setHashInfo(), LbmSortedAggExecStreamTest::testSortedAgg(), and BTreeBuilder::truncateExternal().

{
    clear();
    for (uint i = 0; i < tupleProjection.size(); ++i) {
        push_back(tupleDescriptor[tupleProjection[i]]);
    }
}

int TupleDescriptor::compareTuplesKey	(	TupleData const &	tuple1,
		TupleData const &	tuple2,
		uint	keyCount
	)			const

Definition at line 137 of file TupleDescriptor.cpp.

References min(), and TupleDatum::pData.

Referenced by LbmEntry::compareEntry(), ReshapeExecStream::compareInput(), compareTuples(), LbmSplicerExecStream::findBTreeEntry(), LbmSplicerExecStream::getValidatedTuple(), BTreeSearchExecStream::testInterval(), and BTreePrefetchSearchExecStream::testNonLeafInterval().

{
    assert(keyCount <= std::min(tuple1.size(), tuple2.size()));

    for (uint i = 0; i < keyCount; ++i) {
        TupleDatum const &datum1 = tuple1[i];
        TupleDatum const &datum2 = tuple2[i];
        // TODO:  parameterize NULL-value collation
        if (!datum1.pData) {
            if (!datum2.pData) {
                continue;
            }
            return -(i + 1);
        } else if (!datum2.pData) {
            return (i + 1);
        }
        int c = (*this)[i].pTypeDescriptor->compareValues(
            datum1.pData,
            datum1.cbData,
            datum2.pData,
            datum2.cbData);
        if (c > 0) {
            return (i + 1);
        } else if (c < 0) {
            return -(i + 1);
        }
    }
    return 0;
}

int TupleDescriptor::compareTuples	(	TupleData const &	tuple1,
		TupleData const &	tuple2
	)			const

Definition at line 82 of file TupleDescriptor.cpp.

References compareTuplesKey(), and min().

Referenced by LcsColumnReader::applyFilters(), BTreeKeyedNodeAccessor< NodeAccessor, KeyAccessor >::binarySearch(), BTreeWriter::checkMonotonicity(), BTreeSearchExecStream::checkNextKey(), BTreeKeyedNodeAccessor< NodeAccessor, KeyAccessor >::compareFirstKey(), ReshapeExecStream::compareInput(), ExternalSortInfo::compareKeys(), LcsColumnReader::findVal(), LcsCompareColKeyUsingOffsetIndex::lessThan(), LhxHashKeyAccessor::matches(), LcsHash::search(), BTreeSearchExecStream::testInterval(), BTreePrefetchSearchExecStream::testNonLeafInterval(), LbmReaderTest::testSingleTupleReader(), ExecStreamUnitTestBase::verifyBufferedOutput(), and BTreeVerifier::verifyNode().

{
    int keyComp;
    // REVIEW:  should pass n as a param instead of recalculating it each time
    size_t keyCount = std::min(tuple1.size(),tuple2.size());
    keyCount = std::min(keyCount,size());
    keyComp = compareTuplesKey(tuple1, tuple2, keyCount);
    return keyComp;
}

int TupleDescriptor::compareTuples	(	TupleData const &	tuple1,
		TupleProjection const &	proj1,
		TupleData const &	tuple2,
		TupleProjection const &	proj2,
		bool *	containsNullKey = NULL
	)			const

Definition at line 94 of file TupleDescriptor.cpp.

References min(), and TupleDatum::pData.

{
    size_t keyCount = std::min(proj1.size(), proj2.size());

    if (containsNullKey) {
        *containsNullKey = false;
    }
    for (uint i = 0; i < keyCount; ++i) {
        TupleDatum const &datum1 = tuple1[proj1[i]];
        TupleDatum const &datum2 = tuple2[proj2[i]];
        // TODO:  parameterize NULL-value collation
        if (!datum1.pData) {
            if (containsNullKey) {
                *containsNullKey = true;
            }
            if (!datum2.pData) {
                continue;
            }
            return -(i + 1);
        } else if (!datum2.pData) {
            if (containsNullKey) {
                *containsNullKey = true;
            }
            return (i + 1);
        }
        int c = (*this)[i].pTypeDescriptor->compareValues(
            datum1.pData,
            datum1.cbData,
            datum2.pData,
            datum2.cbData);
        if (c > 0) {
            return (i + 1);
        } else if (c < 0) {
            return -(i + 1);
        }
    }
    return 0;

}

void TupleDescriptor::writePersistent

(

ByteOutputStream &

)

const

Definition at line 199 of file TupleDescriptor.cpp.

References ByteOutputStream::writeValue().

Referenced by FtrsTableWriter::describeParticipant(), and BTreeWriter::describeParticipant().

{
    uint32_t iData = htonl(size());
    stream.writeValue(iData);
    for (uint i = 0; i < size(); ++i) {
        TupleAttributeDescriptor const &attrDesc = (*this)[i];
        iData = htonl(attrDesc.pTypeDescriptor->getOrdinal());
        stream.writeValue(iData);
        iData = htonl(attrDesc.isNullable);
        stream.writeValue(iData);
        // Assume TupleAttributeDescriptor is long in htonl()
        iData = htonl(attrDesc.cbStorage);
        stream.writeValue(iData);
    }
}

void TupleDescriptor::readPersistent	(	ByteInputStream &	,
		StoredTypeDescriptorFactory const &
	)

Definition at line 215 of file TupleDescriptor.cpp.

References StoredTypeDescriptorFactory::newDataType(), and ByteInputStream::readValue().

Referenced by FtrsTableWriterFactory::loadParticipant(), and BTreeRecoveryFactory::loadParticipant().

{
    clear();
    uint32_t n;
    stream.readValue(n);
    n = ntohl(n);
    for (uint i = 0; i < n; ++i) {
        uint32_t iData;
        stream.readValue(iData);
        StoredTypeDescriptor const &typeDescriptor =
            typeFactory.newDataType(ntohl(iData));
        stream.readValue(iData);
        bool isNullable = ntohl(iData);
        stream.readValue(iData);
        TupleStorageByteLength cbStorage = ntohl(iData);
        push_back(
            TupleAttributeDescriptor(
                typeDescriptor,isNullable,cbStorage));
    }
}

void TupleDescriptor::visit	(	TupleData const &	tuple,
		DataVisitor &	dataVisitor,
		bool	visitLengths
	)			const

Definition at line 170 of file TupleDescriptor.cpp.

References DataVisitor::visitBytes(), and DataVisitor::visitUnsignedInt().

Referenced by TuplePrinter::print().

{
    for (uint i = 0; i < tuple.size(); ++i) {
        if (!tuple[i].pData) {
            if (visitLengths) {
                dataVisitor.visitUnsignedInt(0);
            }
            dataVisitor.visitBytes(NULL,0);
        } else {
            if (visitLengths) {
                dataVisitor.visitUnsignedInt(tuple[i].cbData);
            }
            (*this)[i].pTypeDescriptor->visitValue(
                dataVisitor,
                tuple[i].pData,
                tuple[i].cbData);
        }
    }
}

bool TupleDescriptor::containsNullable

(

)

const

Definition at line 273 of file TupleDescriptor.cpp.

Referenced by BTreeSearchExecStream::prepare().

{
    for (uint i = 0; i < size(); ++i) {
        if ((*this)[i].isNullable) {
            return true;
        }
    }
    return false;
}

bool TupleDescriptor::storageEqual

(

TupleDescriptor const &

other

)

const

Performs a comparison only of type & size, not nullability.

Definition at line 283 of file TupleDescriptor.cpp.

References TupleAttributeDescriptor::cbStorage, StoredTypeDescriptor::getOrdinal(), and TupleAttributeDescriptor::pTypeDescriptor.

Referenced by CalcExecStream::prepare().

{
    uint sz = size();
    if (other.size() != sz) {
        return false;
    }

    TupleAttributeDescriptor const * us;
    TupleAttributeDescriptor const * them;

    for (uint i = 0; i < sz; ++i) {
        us = &(*this)[i];
        them = &other[i];
        if ((us->pTypeDescriptor->getOrdinal() !=
             them->pTypeDescriptor->getOrdinal()) ||
            us->cbStorage != them->cbStorage) {
            return false;
        }
    }
    return true;
}

TupleStorageByteLength TupleDescriptor::getMaxByteCount

(

)

const

Definition at line 306 of file TupleDescriptor.cpp.

Referenced by LbmEntry::getSizeBounds().

{
    TupleStorageByteLength length = 0;

    for (uint i = 0; i < size(); i ++) {
        length += (*this)[i].cbStorage;
    }
    return length;
}

---

The documentation for this class was generated from the following files:

• /home/pub/open/dev/fennel/tuple/TupleDescriptor.h
• /home/pub/open/dev/fennel/tuple/TupleDescriptor.cpp

---