Merge branch 'release/2.2.0' of myrepo.no.oracle.com:connector-python into release/2.2.0

Author: Reggie Burnett

lib/mysqlx/crud.py

@@ -21,7 +21,10 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 
-from .statement import AddStatement, RemoveStatement, TableDeleteStatement, FindStatement, SelectStatement
+from .statement import (AddStatement, RemoveStatement, TableDeleteStatement,
+                        FindStatement, SelectStatement,
+                        CreateCollectionIndexStatement,
+                        DropCollectionIndexStatement)
 
 
 _COUNT_TABLES_QUERY = ("SELECT COUNT(*) FROM information_schema.tables "
@@ -146,6 +149,23 @@ def count(self):
         sql = _COUNT_QUERY.format(self._schema.name, self._name)
         return self._connection.execute_sql_scalar(sql)
 
+    def create_index(self, index_name, is_unique):
+        """Creates a collection index.
+
+        Args:
+            index_name (string): Index name.
+            is_unique (bool): True if the index is unique.
+        """
+        return CreateCollectionIndexStatement(self, index_name, is_unique)
+
+    def drop_index(self, index_name):
+        """Drops a collection index.
+
+        Args:
+            index_name (string): Index name.
+        """
+        return DropCollectionIndexStatement(self, index_name)
+
 
 class Table(DatabaseObject):
     def __init__(self, schema, name):

lib/mysqlx/protocol.py

@@ -181,6 +181,10 @@ def _create_any(self, arg):
             val = MySQLxDatatypes.Scalar.String(value=arg)
             scalar = MySQLxDatatypes.Scalar(type=8, v_string=val)
             return MySQLxDatatypes.Any(type=1, scalar=scalar)
+        elif isinstance(arg, bool):
+            return MySQLxDatatypes.Any(type=1, scalar=build_bool_scalar(arg))
+        elif isinstance(arg, int):
+            return MySQLxDatatypes.Any(type=1, scalar=build_int_scalar(arg))
         return None
 
     def close_result(self, rs):
@@ -266,4 +270,4 @@ def arg_object_to_expr(self, value, allow_relational):
                 return MySQLxExpr.Expr(type=MySQLxExpr.Expr.LITERAL, literal=ExprParser().build_string_scalar(value))
         elif isinstance(value, DbDoc):
             return MySQLxExpr.Expr(type=MySQLxExpr.Expr.LITERAL, literal=build_string_scalar(str(value)))
-        raise Exception("Unsupported type")
+        raise Exception("Unsupported type")

lib/mysqlx/statement.py

@@ -173,3 +173,63 @@ def __init__(self, table, condition=None):
 
     def execute(self):
         return self._connection.delete(self)
+
+
+class CreateCollectionIndexStatement(Statement):
+    """A statement that creates an index on a collection.
+
+    Args:
+        collection (mysqlx.Collection): Collection.
+        index_name (string): Index name.
+        is_unique (bool): True if the index is unique.
+    """
+    def __init__(self, collection, index_name, is_unique):
+        super(CreateCollectionIndexStatement, self).__init__(target=collection)
+        self._index_name = index_name
+        self._is_unique = is_unique
+        self._fields = []
+
+    def field(self, document_path, column_type, is_required):
+        """Add the field specification to this index creation statement.
+
+        Args:
+            document_path (string): Document path.
+            column_type (string): Column type.
+            is_required (bool): True if the field is required.
+        """
+        self._fields.append((document_path, column_type, is_required,))
+        return self
+
+    def execute(self):
+        """Execute the Statement.
+
+        Returns:
+            mysqlx.Result
+        """
+        fields = [item for sublist in self._fields for item in sublist]
+        return self._connection.execute_nonquery(
+            "xplugin", "create_collection_index", True,
+            self._target.schema.name, self._target.name, self._index_name,
+            self._is_unique, *fields)
+
+
+class DropCollectionIndexStatement(Statement):
+    """A statement that drops an index on a collection.
+
+    Args:
+        collection (mysqlx.Collection): Collection.
+        index_name (string): Index name.
+    """
+    def __init__(self, collection, index_name):
+        super(DropCollectionIndexStatement, self).__init__(target=collection)
+        self._index_name = index_name
+
+    def execute(self):
+        """Execute the Statement.
+
+        Returns:
+            mysqlx.Result
+        """
+        return self._connection.execute_nonquery(
+            "xplugin", "drop_collection_index", True,
+            self._target.schema.name, self._target.name, self._index_name)

tests/mysqld.py

@@ -556,6 +556,7 @@ def start(self):
             'bind_address': self._bind_address,
             'port': self._port,
             'mysqlx_port': self._mysqlx_port,
+            'mysqlx_plugin': 'mysqlx.so' if os.name == 'posix' else 'mysqlx',
             'unix_socket': _convert_forward_slash(self._unix_socket),
             'ssl_dir': _convert_forward_slash(self._ssldir),
             'pid_file': _convert_forward_slash(self._pid_file),

tests/test_mysqlx_crud.py

@@ -251,6 +251,45 @@ def test_results(self):
         docs1 = result1.fetch_all();
         self.assertEqual(4, len(docs1))
 
+    def test_create_index(self):
+        collection_name = "collection_test"
+        collection = self.schema.create_collection(collection_name)
+
+        index_name = "age_idx"
+        collection.create_index(index_name, True) \
+            .field("$.age", "INT", False).execute()
+
+        show_indexes_sql = (
+            "SHOW INDEXES FROM `{0}`.`{1}` WHERE Key_name='{2}'"
+            "".format(self.schema_name, collection_name, index_name)
+        )
+
+        result = self.node_session.sql(show_indexes_sql).execute()
+        rows = result.fetch_all()
+        self.assertEqual(1, len(rows))
+
+    def test_drop_index(self):
+        collection_name = "collection_test"
+        collection = self.schema.create_collection(collection_name)
+
+        index_name = "age_idx"
+        collection.create_index(index_name, True) \
+            .field("$.age", "INT", False).execute()
+
+        show_indexes_sql = (
+            "SHOW INDEXES FROM `{0}`.`{1}` WHERE Key_name='{2}'"
+            "".format(self.schema_name, collection_name, index_name)
+        )
+
+        result = self.node_session.sql(show_indexes_sql).execute()
+        rows = result.fetch_all()
+        self.assertEqual(1, len(rows))
+
+        collection.drop_index(index_name).execute()
+        result = self.node_session.sql(show_indexes_sql).execute()
+        rows = result.fetch_all()
+        self.assertEqual(0, len(rows))
+
 
 @unittest.skipIf(MYSQLX_AVAILABLE is False, "MySQLX not available")
 @unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")

unittests.py

@@ -101,7 +101,7 @@
 MY_CNF = """
 # MySQL option file for MySQL Connector/Python tests
 [mysqld-5.7]
-plugin-load=mysqlx
+plugin-load={mysqlx_plugin}
 loose_mysqlx_port={mysqlx_port}
 
 [mysqld-5.6]