| /* |
| * Copyright 2009-2010 by The Regents of the University of California |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * you may obtain a copy of the License from |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package edu.uci.ics.hyracks.tests.am.btree; |
| |
| import java.io.DataOutput; |
| import java.io.File; |
| |
| import org.junit.After; |
| import org.junit.Before; |
| |
| import edu.uci.ics.hyracks.api.constraints.PartitionConstraintHelper; |
| import edu.uci.ics.hyracks.api.dataflow.value.IBinaryComparatorFactory; |
| import edu.uci.ics.hyracks.api.dataflow.value.ISerializerDeserializer; |
| import edu.uci.ics.hyracks.api.dataflow.value.ITypeTraits; |
| import edu.uci.ics.hyracks.api.dataflow.value.RecordDescriptor; |
| import edu.uci.ics.hyracks.api.exceptions.HyracksException; |
| import edu.uci.ics.hyracks.api.io.FileReference; |
| import edu.uci.ics.hyracks.api.job.JobSpecification; |
| import edu.uci.ics.hyracks.data.std.accessors.PointableBinaryComparatorFactory; |
| import edu.uci.ics.hyracks.data.std.primitive.UTF8StringPointable; |
| import edu.uci.ics.hyracks.dataflow.common.comm.io.ArrayTupleBuilder; |
| import edu.uci.ics.hyracks.dataflow.common.data.marshalling.UTF8StringSerializerDeserializer; |
| import edu.uci.ics.hyracks.dataflow.common.data.parsers.IValueParserFactory; |
| import edu.uci.ics.hyracks.dataflow.common.data.parsers.UTF8StringParserFactory; |
| import edu.uci.ics.hyracks.dataflow.std.connectors.OneToOneConnectorDescriptor; |
| import edu.uci.ics.hyracks.dataflow.std.file.ConstantFileSplitProvider; |
| import edu.uci.ics.hyracks.dataflow.std.file.DelimitedDataTupleParserFactory; |
| import edu.uci.ics.hyracks.dataflow.std.file.FileScanOperatorDescriptor; |
| import edu.uci.ics.hyracks.dataflow.std.file.FileSplit; |
| import edu.uci.ics.hyracks.dataflow.std.file.IFileSplitProvider; |
| import edu.uci.ics.hyracks.dataflow.std.misc.ConstantTupleSourceOperatorDescriptor; |
| import edu.uci.ics.hyracks.dataflow.std.misc.NullSinkOperatorDescriptor; |
| import edu.uci.ics.hyracks.dataflow.std.sort.ExternalSortOperatorDescriptor; |
| import edu.uci.ics.hyracks.storage.am.btree.dataflow.BTreeSearchOperatorDescriptor; |
| import edu.uci.ics.hyracks.storage.am.common.api.IIndexLifecycleManagerProvider; |
| import edu.uci.ics.hyracks.storage.am.common.dataflow.IIndexDataflowHelperFactory; |
| import edu.uci.ics.hyracks.storage.am.common.dataflow.IndexDropOperatorDescriptor; |
| import edu.uci.ics.hyracks.storage.am.common.dataflow.TreeIndexBulkLoadOperatorDescriptor; |
| import edu.uci.ics.hyracks.storage.am.common.dataflow.TreeIndexCreateOperatorDescriptor; |
| import edu.uci.ics.hyracks.storage.am.common.dataflow.TreeIndexInsertUpdateDeleteOperatorDescriptor; |
| import edu.uci.ics.hyracks.storage.am.common.impls.NoOpOperationCallbackFactory; |
| import edu.uci.ics.hyracks.storage.am.common.ophelpers.IndexOperation; |
| import edu.uci.ics.hyracks.storage.common.IStorageManagerInterface; |
| import edu.uci.ics.hyracks.storage.common.file.TransientLocalResourceFactoryProvider; |
| import edu.uci.ics.hyracks.test.support.TestIndexLifecycleManagerProvider; |
| import edu.uci.ics.hyracks.test.support.TestStorageManagerComponentHolder; |
| import edu.uci.ics.hyracks.test.support.TestStorageManagerInterface; |
| import edu.uci.ics.hyracks.tests.am.common.ITreeIndexOperatorTestHelper; |
| import edu.uci.ics.hyracks.tests.integration.AbstractIntegrationTest; |
| |
| public abstract class AbstractBTreeOperatorTest extends AbstractIntegrationTest { |
| static { |
| TestStorageManagerComponentHolder.init(8192, 20, 20); |
| } |
| |
| protected final IStorageManagerInterface storageManager = new TestStorageManagerInterface(); |
| protected final IIndexLifecycleManagerProvider lcManagerProvider = new TestIndexLifecycleManagerProvider(); |
| protected IIndexDataflowHelperFactory dataflowHelperFactory; |
| |
| // field, type and key declarations for primary index |
| protected final int primaryFieldCount = 6; |
| protected final ITypeTraits[] primaryTypeTraits = new ITypeTraits[primaryFieldCount]; |
| protected final int primaryKeyFieldCount = 1; |
| protected final IBinaryComparatorFactory[] primaryComparatorFactories = new IBinaryComparatorFactory[primaryKeyFieldCount]; |
| |
| protected final RecordDescriptor primaryRecDesc = new RecordDescriptor(new ISerializerDeserializer[] { |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE }); |
| |
| // to be set by subclasses |
| protected String primaryFileName; |
| protected IFileSplitProvider primarySplitProvider; |
| |
| // field, type and key declarations for secondary indexes |
| protected final int secondaryFieldCount = 2; |
| protected final ITypeTraits[] secondaryTypeTraits = new ITypeTraits[secondaryFieldCount]; |
| protected final int secondaryKeyFieldCount = 2; |
| protected final IBinaryComparatorFactory[] secondaryComparatorFactories = new IBinaryComparatorFactory[secondaryKeyFieldCount]; |
| |
| protected final RecordDescriptor secondaryRecDesc = new RecordDescriptor(new ISerializerDeserializer[] { |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE }); |
| |
| protected String secondaryFileName; |
| protected IFileSplitProvider secondarySplitProvider; |
| |
| protected ITreeIndexOperatorTestHelper testHelper; |
| |
| protected ITreeIndexOperatorTestHelper createTestHelper() throws HyracksException { |
| return new BTreeOperatorTestHelper(); |
| } |
| |
| @Before |
| public void setup() throws Exception { |
| testHelper = createTestHelper(); |
| dataflowHelperFactory = createDataFlowHelperFactory(); |
| primaryFileName = testHelper.getPrimaryIndexName(); |
| primarySplitProvider = new ConstantFileSplitProvider(new FileSplit[] { new FileSplit(NC1_ID, new FileReference( |
| new File(primaryFileName))) }); |
| secondaryFileName = testHelper.getSecondaryIndexName(); |
| secondarySplitProvider = new ConstantFileSplitProvider(new FileSplit[] { new FileSplit(NC1_ID, |
| new FileReference(new File(secondaryFileName))) }); |
| |
| // field, type and key declarations for primary index |
| primaryTypeTraits[0] = UTF8StringPointable.TYPE_TRAITS; |
| primaryTypeTraits[1] = UTF8StringPointable.TYPE_TRAITS; |
| primaryTypeTraits[2] = UTF8StringPointable.TYPE_TRAITS; |
| primaryTypeTraits[3] = UTF8StringPointable.TYPE_TRAITS; |
| primaryTypeTraits[4] = UTF8StringPointable.TYPE_TRAITS; |
| primaryTypeTraits[5] = UTF8StringPointable.TYPE_TRAITS; |
| primaryComparatorFactories[0] = PointableBinaryComparatorFactory.of(UTF8StringPointable.FACTORY); |
| |
| // field, type and key declarations for secondary indexes |
| secondaryTypeTraits[0] = UTF8StringPointable.TYPE_TRAITS; |
| secondaryTypeTraits[1] = UTF8StringPointable.TYPE_TRAITS; |
| secondaryComparatorFactories[0] = PointableBinaryComparatorFactory.of(UTF8StringPointable.FACTORY); |
| secondaryComparatorFactories[1] = PointableBinaryComparatorFactory.of(UTF8StringPointable.FACTORY); |
| } |
| |
| protected abstract IIndexDataflowHelperFactory createDataFlowHelperFactory(); |
| |
| public void createPrimaryIndex() throws Exception { |
| JobSpecification spec = new JobSpecification(); |
| TransientLocalResourceFactoryProvider localResourceFactoryProvider = new TransientLocalResourceFactoryProvider(); |
| TreeIndexCreateOperatorDescriptor primaryCreateOp = new TreeIndexCreateOperatorDescriptor(spec, storageManager, |
| lcManagerProvider, primarySplitProvider, primaryTypeTraits, primaryComparatorFactories, |
| dataflowHelperFactory, localResourceFactoryProvider, NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, primaryCreateOp, NC1_ID); |
| spec.addRoot(primaryCreateOp); |
| runTest(spec); |
| } |
| |
| protected void loadPrimaryIndex() throws Exception { |
| JobSpecification spec = new JobSpecification(); |
| |
| FileSplit[] ordersSplits = new FileSplit[] { new FileSplit(NC1_ID, new FileReference(new File( |
| "data/tpch0.001/orders-part1.tbl"))) }; |
| IFileSplitProvider ordersSplitProvider = new ConstantFileSplitProvider(ordersSplits); |
| RecordDescriptor ordersDesc = new RecordDescriptor(new ISerializerDeserializer[] { |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE }); |
| |
| FileScanOperatorDescriptor ordScanner = new FileScanOperatorDescriptor(spec, ordersSplitProvider, |
| new DelimitedDataTupleParserFactory(new IValueParserFactory[] { UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE }, '|'), ordersDesc); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, ordScanner, NC1_ID); |
| |
| ExternalSortOperatorDescriptor sorter = new ExternalSortOperatorDescriptor(spec, 1000, new int[] { 0 }, |
| new IBinaryComparatorFactory[] { PointableBinaryComparatorFactory.of(UTF8StringPointable.FACTORY) }, |
| ordersDesc); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, sorter, NC1_ID); |
| |
| int[] fieldPermutation = { 0, 1, 2, 4, 5, 7 }; |
| TreeIndexBulkLoadOperatorDescriptor primaryBtreeBulkLoad = new TreeIndexBulkLoadOperatorDescriptor(spec, |
| storageManager, lcManagerProvider, primarySplitProvider, primaryTypeTraits, primaryComparatorFactories, |
| fieldPermutation, 0.7f, true, dataflowHelperFactory, NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, primaryBtreeBulkLoad, NC1_ID); |
| |
| spec.connect(new OneToOneConnectorDescriptor(spec), ordScanner, 0, sorter, 0); |
| |
| spec.connect(new OneToOneConnectorDescriptor(spec), sorter, 0, primaryBtreeBulkLoad, 0); |
| |
| spec.addRoot(primaryBtreeBulkLoad); |
| runTest(spec); |
| } |
| |
| public void createSecondaryIndex() throws Exception { |
| JobSpecification spec = new JobSpecification(); |
| TransientLocalResourceFactoryProvider localResourceFactoryProvider = new TransientLocalResourceFactoryProvider(); |
| TreeIndexCreateOperatorDescriptor secondaryCreateOp = new TreeIndexCreateOperatorDescriptor(spec, |
| storageManager, lcManagerProvider, secondarySplitProvider, secondaryTypeTraits, |
| secondaryComparatorFactories, dataflowHelperFactory, localResourceFactoryProvider, |
| NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, secondaryCreateOp, NC1_ID); |
| spec.addRoot(secondaryCreateOp); |
| runTest(spec); |
| } |
| |
| protected void loadSecondaryIndex() throws Exception { |
| JobSpecification spec = new JobSpecification(); |
| |
| // build dummy tuple containing nothing |
| ArrayTupleBuilder tb = new ArrayTupleBuilder(primaryKeyFieldCount * 2); |
| DataOutput dos = tb.getDataOutput(); |
| |
| tb.reset(); |
| UTF8StringSerializerDeserializer.INSTANCE.serialize("0", dos); |
| tb.addFieldEndOffset(); |
| |
| ISerializerDeserializer[] keyRecDescSers = { UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE }; |
| RecordDescriptor keyRecDesc = new RecordDescriptor(keyRecDescSers); |
| |
| ConstantTupleSourceOperatorDescriptor keyProviderOp = new ConstantTupleSourceOperatorDescriptor(spec, |
| keyRecDesc, tb.getFieldEndOffsets(), tb.getByteArray(), tb.getSize()); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, keyProviderOp, NC1_ID); |
| |
| int[] lowKeyFields = null; // - infinity |
| int[] highKeyFields = null; // + infinity |
| |
| // scan primary index |
| BTreeSearchOperatorDescriptor primaryBtreeSearchOp = new BTreeSearchOperatorDescriptor(spec, primaryRecDesc, |
| storageManager, lcManagerProvider, primarySplitProvider, primaryTypeTraits, primaryComparatorFactories, |
| lowKeyFields, highKeyFields, true, true, dataflowHelperFactory, false, |
| NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, primaryBtreeSearchOp, NC1_ID); |
| |
| // sort based on secondary keys |
| ExternalSortOperatorDescriptor sorter = new ExternalSortOperatorDescriptor(spec, 1000, new int[] { 3, 0 }, |
| new IBinaryComparatorFactory[] { PointableBinaryComparatorFactory.of(UTF8StringPointable.FACTORY), |
| PointableBinaryComparatorFactory.of(UTF8StringPointable.FACTORY) }, primaryRecDesc); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, sorter, NC1_ID); |
| |
| // load secondary index |
| int[] fieldPermutation = { 3, 0 }; |
| TreeIndexBulkLoadOperatorDescriptor secondaryBtreeBulkLoad = new TreeIndexBulkLoadOperatorDescriptor(spec, |
| storageManager, lcManagerProvider, secondarySplitProvider, secondaryTypeTraits, |
| secondaryComparatorFactories, fieldPermutation, 0.7f, true, dataflowHelperFactory, |
| NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, secondaryBtreeBulkLoad, NC1_ID); |
| |
| spec.connect(new OneToOneConnectorDescriptor(spec), keyProviderOp, 0, primaryBtreeSearchOp, 0); |
| spec.connect(new OneToOneConnectorDescriptor(spec), primaryBtreeSearchOp, 0, sorter, 0); |
| spec.connect(new OneToOneConnectorDescriptor(spec), sorter, 0, secondaryBtreeBulkLoad, 0); |
| |
| spec.addRoot(secondaryBtreeBulkLoad); |
| runTest(spec); |
| } |
| |
| protected void insertPipeline(boolean useUpsert) throws Exception { |
| IndexOperation pipelineOperation = useUpsert ? IndexOperation.UPSERT : IndexOperation.INSERT; |
| JobSpecification spec = new JobSpecification(); |
| |
| FileSplit[] ordersSplits = new FileSplit[] { new FileSplit(NC1_ID, new FileReference(new File( |
| "data/tpch0.001/orders-part2.tbl"))) }; |
| IFileSplitProvider ordersSplitProvider = new ConstantFileSplitProvider(ordersSplits); |
| RecordDescriptor ordersDesc = new RecordDescriptor(new ISerializerDeserializer[] { |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE, UTF8StringSerializerDeserializer.INSTANCE, |
| UTF8StringSerializerDeserializer.INSTANCE }); |
| |
| FileScanOperatorDescriptor ordScanner = new FileScanOperatorDescriptor(spec, ordersSplitProvider, |
| new DelimitedDataTupleParserFactory(new IValueParserFactory[] { UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE, |
| UTF8StringParserFactory.INSTANCE, UTF8StringParserFactory.INSTANCE }, '|'), ordersDesc); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, ordScanner, NC1_ID); |
| |
| // insert into primary index |
| int[] primaryFieldPermutation = { 0, 1, 2, 4, 5, 7 }; |
| TreeIndexInsertUpdateDeleteOperatorDescriptor primaryBtreeInsertOp = new TreeIndexInsertUpdateDeleteOperatorDescriptor( |
| spec, ordersDesc, storageManager, lcManagerProvider, primarySplitProvider, primaryTypeTraits, |
| primaryComparatorFactories, primaryFieldPermutation, pipelineOperation, dataflowHelperFactory, null, |
| NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, primaryBtreeInsertOp, NC1_ID); |
| |
| // first secondary index |
| int[] fieldPermutationB = { 4, 0 }; |
| TreeIndexInsertUpdateDeleteOperatorDescriptor secondaryInsertOp = new TreeIndexInsertUpdateDeleteOperatorDescriptor( |
| spec, ordersDesc, storageManager, lcManagerProvider, secondarySplitProvider, secondaryTypeTraits, |
| secondaryComparatorFactories, fieldPermutationB, pipelineOperation, dataflowHelperFactory, null, |
| NoOpOperationCallbackFactory.INSTANCE); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, secondaryInsertOp, NC1_ID); |
| |
| NullSinkOperatorDescriptor nullSink = new NullSinkOperatorDescriptor(spec); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, nullSink, NC1_ID); |
| |
| spec.connect(new OneToOneConnectorDescriptor(spec), ordScanner, 0, primaryBtreeInsertOp, 0); |
| |
| spec.connect(new OneToOneConnectorDescriptor(spec), primaryBtreeInsertOp, 0, secondaryInsertOp, 0); |
| |
| spec.connect(new OneToOneConnectorDescriptor(spec), secondaryInsertOp, 0, nullSink, 0); |
| |
| spec.addRoot(nullSink); |
| runTest(spec); |
| } |
| |
| protected void destroyPrimaryIndex() throws Exception { |
| JobSpecification spec = new JobSpecification(); |
| IndexDropOperatorDescriptor primaryDropOp = new IndexDropOperatorDescriptor(spec, storageManager, |
| lcManagerProvider, primarySplitProvider, dataflowHelperFactory); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, primaryDropOp, NC1_ID); |
| spec.addRoot(primaryDropOp); |
| runTest(spec); |
| } |
| |
| protected void destroySecondaryIndex() throws Exception { |
| JobSpecification spec = new JobSpecification(); |
| IndexDropOperatorDescriptor secondaryDropOp = new IndexDropOperatorDescriptor(spec, storageManager, |
| lcManagerProvider, secondarySplitProvider, dataflowHelperFactory); |
| PartitionConstraintHelper.addAbsoluteLocationConstraint(spec, secondaryDropOp, NC1_ID); |
| spec.addRoot(secondaryDropOp); |
| runTest(spec); |
| } |
| |
| @After |
| public abstract void cleanup() throws Exception; |
| } |
