com.mysql.cj.api.xdevapi.CreateCollectionIndexStatement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-java

JDBC Type 4 driver for MySQL

There is a newer version: 8.0.33

/*
  Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.

  The MySQL Connector/J is licensed under the terms of the GPLv2
  , like most MySQL Connectors.
  There are special exceptions to the terms and conditions of the GPLv2 as it is applied to
  this software, see the FOSS License Exception
  .

  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; version 2
  of the License.

  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., 51 Franklin St, Fifth
  Floor, Boston, MA 02110-1301  USA

 */

package com.mysql.cj.api.xdevapi;

/**
 * A statement that creates an index on a collection.
 */
public interface CreateCollectionIndexStatement extends Statement {
    /**
     * Add the field specification to this index creation statement.
     * 
     * @param docPath
     *            document path
     * @param type
     *            type
     * @param notNull
     *            notNull flag
     * @return {@link CreateCollectionIndexStatement}
     */
    CreateCollectionIndexStatement field(String docPath, String type, boolean notNull);
}