test/unit/org/apache/cassandra/index/sai/cql/CollectionIndexingTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 at
 *
 *     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 org.apache.cassandra.index.sai.cql;

import java.util.Arrays;
import java.util.HashMap;

import org.junit.Before;
import org.junit.Test;

import org.apache.cassandra.cql3.restrictions.StatementRestrictions;
import org.apache.cassandra.index.sai.SAITester;

import static org.junit.Assert.assertEquals;

/**
 * This test is primarily handling edge conditions, error conditions
 * and basic functionality. Comprehensive type testing of collections
 * is in the cql/types/collections package
 */
public class CollectionIndexingTest extends SAITester
{
    @Before
    public void setup()
    {
        requireNetwork();
    }

    @Test
    public void indexMap()
    {
        createPopulatedMap(createIndexDDL("value"));
        assertEquals(2, execute("SELECT * FROM %s WHERE value CONTAINS 'v1'").size());
    }

    @Test
    public void indexMapKeys()
    {
        createPopulatedMap(createIndexDDL("KEYS(value)"));
        assertEquals(2, execute("SELECT * FROM %s WHERE value CONTAINS KEY 1").size());
    }

    @Test
    public void indexMapValues()
    {
        createPopulatedMap(createIndexDDL("VALUES(value)"));
        assertEquals(2, execute("SELECT * FROM %s WHERE value CONTAINS 'v1'").size());
    }

    @Test
    public void indexMapEntries()
    {
        createPopulatedMap(createIndexDDL("ENTRIES(value)"));
        assertEquals(2, execute("SELECT * FROM %s WHERE value[1] = 'v1'").size());
        assertEquals(1, execute("SELECT * FROM %s WHERE value[1] = 'v1' AND value[2] = 'v2'").size());
    }

    @Test
    public void indexFrozenList()
    {
        createPopulatedFrozenList(createIndexDDL("FULL(value)"));
        assertEquals(2, execute("SELECT * FROM %s WHERE value = ?", Arrays.asList(1, 2, 3)).size());
    }

    @Test
    public void indexFrozenMap() throws Throwable
    {
        createPopulatedFrozenMap(createIndexDDL("FULL(value)"));
        assertEquals(1, execute("SELECT * FROM %s WHERE value = ?", new HashMap<Integer, String>() {{
            put(1, "v1");
            put(2, "v2");
        }}).size());

    }

    @Test
    public void indexFrozenMapQueryKeys() throws Throwable
    {
        createPopulatedFrozenMap(createIndexDDL("FULL(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value contains key 1");
    }

    @Test
    public void indexFrozenMapQueryValues() throws Throwable
    {
        createPopulatedFrozenMap(createIndexDDL("FULL(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value contains 'v1'");
    }

    @Test
    public void indexFrozenMapQueryEntries() throws Throwable
    {
        createPopulatedFrozenMap(createIndexDDL("FULL(value)"));
        assertInvalidMessage("Map-entry equality predicates on frozen map column value are not supported",
                "SELECT * FROM %s WHERE value[1] = 'v1'");
    }

    @Test
    public void indexMapEntriesQueryEq() throws Throwable
    {
        createPopulatedMap(createIndexDDL("ENTRIES(value)"));
        assertInvalidMessage("Collection column 'value' (map<int, text>) cannot be restricted by a '=' relation",
                "SELECT * FROM %s WHERE value = ?", Arrays.asList(1, 2));
    }

    @Test
    public void indexMapEntriesQueryKeys() throws Throwable
    {
        createPopulatedMap(createIndexDDL("ENTRIES(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value contains key 1");
    }

    @Test
    public void indexMapEntriesQueryValues() throws Throwable
    {
        createPopulatedMap(createIndexDDL("ENTRIES(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value contains 'v1'");
    }

    @Test
    public void indexMapKeysQueryEq() throws Throwable
    {
        createPopulatedMap(createIndexDDL("KEYS(value)"));
        assertInvalidMessage("Collection column 'value' (map<int, text>) cannot be restricted by a '=' relation",
                "SELECT * FROM %s WHERE value = ?", Arrays.asList(1, 2));
    }

    @Test
    public void indexMapKeysQueryValues() throws Throwable
    {
        createPopulatedMap(createIndexDDL("KEYS(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value contains 'v1'");
    }

    @Test
    public void indexMapKeysQueryEntries() throws Throwable
    {
        createPopulatedMap(createIndexDDL("KEYS(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value[1] = 'v1'");
    }

    @Test
    public void indexMapValuesQueryEq() throws Throwable
    {
        createPopulatedMap(createIndexDDL("VALUES(value)"));
        assertInvalidMessage("Collection column 'value' (map<int, text>) cannot be restricted by a '=' relation",
                "SELECT * FROM %s WHERE value = ?", Arrays.asList(1, 2));
    }

    @Test
    public void indexMapValuesQueryKeys() throws Throwable
    {
        createPopulatedMap(createIndexDDL("VALUES(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value contains key 1");
    }

    @Test
    public void indexMapValuesQueryEntries() throws Throwable
    {
        createPopulatedMap(createIndexDDL("VALUES(value)"));
        assertUnsupportedIndexOperator(2, "SELECT * FROM %s WHERE value[1] = 'v1'");
    }

    @Test
    public void unindexedContainsExpressions()
    {
        createTable("CREATE TABLE %s (k int PRIMARY KEY, v int, m map<int, int>)");
        createIndex("CREATE INDEX ON %s(v) USING 'SAI'"); // just to make sure that SAI is involved

        Object[] row = row(0, 1, map(2, 3));
        execute("INSERT INTO %s (k, v, m) VALUES (?, ?, ?)", row);
        execute("INSERT INTO %s (k, v, m) VALUES (?, ?, ?)", 1, 1, map(12, 13));

        // try without any indexes on the map
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS 3 ALLOW FILTERING"), row);
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS KEY 2 ALLOW FILTERING"), row);
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS KEY 2 AND m CONTAINS 3 ALLOW FILTERING"), row);

        // try with index on map values
        createIndex("CREATE INDEX ON %s(m) USING 'SAI'");
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS 3"), row);
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS KEY 2 ALLOW FILTERING"), row);
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS KEY 2 AND m CONTAINS 3 ALLOW FILTERING"), row);

        // try with index on map keys
        createIndex("CREATE INDEX ON %s(KEYS(m)) USING 'SAI'");
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS 3"), row);
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS KEY 2"), row);
        assertRows(execute("SELECT k, v, m FROM %s WHERE v = 1 AND m CONTAINS KEY 2 AND m CONTAINS 3"), row);
    }

    private void createPopulatedMap(String createIndex)
    {
        createTable("CREATE TABLE %s (pk int primary key, value map<int, text>)");
        createIndex(createIndex);
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 1, new HashMap<Integer, String>() {{
            put(1, "v1");
            put(2, "v2");
        }});
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 2, new HashMap<Integer, String>() {{
            put(1, "v1");
            put(2, "v3");
        }});
    }

    @SuppressWarnings("SameParameterValue")
    private void createPopulatedFrozenMap(String createIndex)
    {
        createTable("CREATE TABLE %s (pk int primary key, value frozen<map<int, text>>)");
        createIndex(createIndex);
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 1, new HashMap<Integer, String>() {{
            put(1, "v1");
            put(2, "v2");
        }});
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 2, new HashMap<Integer, String>() {{
            put(1, "v1");
            put(2, "v3");
        }});
    }

    @SuppressWarnings("SameParameterValue")
    private void createPopulatedFrozenList(String createIndex)
    {
        createTable("CREATE TABLE %s (pk int primary key, value frozen<list<int>>)");
        createIndex(createIndex);
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 1, Arrays.asList(1, 2, 3));
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 2, Arrays.asList(1, 2, 3));
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 3, Arrays.asList(4, 5, 6));
        execute("INSERT INTO %s (pk, value) VALUES (?, ?)", 4, Arrays.asList(1, 2, 7));
    }

    @SuppressWarnings("SameParameterValue")
    private void assertUnsupportedIndexOperator(int expectedSize, String query, Object... values) throws Throwable
    {
        assertInvalidMessage(StatementRestrictions.REQUIRES_ALLOW_FILTERING_MESSAGE, query, values);
        assertEquals(expectedSize, execute(query + " ALLOW FILTERING").size());
    }

    private static String createIndexDDL(String target)
    {
        return "CREATE INDEX ON %s(" + target + ") USING 'sai'";
    }
}