All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.mysql.cj.xdevapi.SchemaImpl Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) 2015, 2024, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2.0, as published by
 * the Free Software Foundation.
 *
 * This program is designed to work with certain software that is licensed under separate terms, as designated in a particular file or component or in
 * included license documentation. The authors of MySQL hereby grant you an additional permission to link the program and your derivative works with the
 * separately licensed software that they have either included with the program or referenced in the documentation.
 *
 * Without limiting anything contained in the foregoing, this file, which is part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
 * version 1.0, a copy of which can be found at http://oss.oracle.com/licenses/universal-foss-exception.
 *
 * 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, version 2.0, 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.xdevapi;

import java.util.Arrays;
import java.util.List;
import java.util.Set;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Collectors;

import com.mysql.cj.Messages;
import com.mysql.cj.MysqlxSession;
import com.mysql.cj.exceptions.ExceptionFactory;
import com.mysql.cj.exceptions.MysqlErrorNumbers;
import com.mysql.cj.exceptions.WrongArgumentException;
import com.mysql.cj.protocol.x.XMessage;
import com.mysql.cj.protocol.x.XMessageBuilder;
import com.mysql.cj.protocol.x.XProtocolError;
import com.mysql.cj.result.StringValueFactory;
import com.mysql.cj.result.ValueFactory;

/**
 * {@link Schema} implementation.
 */
public class SchemaImpl implements Schema {

    private MysqlxSession mysqlxSession;
    private XMessageBuilder xbuilder;
    private Session session;
    private String name;
    private ValueFactory svf;

    /* package private */ SchemaImpl(MysqlxSession mysqlxSession, Session session, String name) {
        this.mysqlxSession = mysqlxSession;
        this.session = session;
        this.name = name;
        this.xbuilder = (XMessageBuilder) this.mysqlxSession.getMessageBuilder();
        this.svf = new StringValueFactory(this.mysqlxSession.getPropertySet());
    }

    @Override
    public Session getSession() {
        return this.session;
    }

    @Override
    public Schema getSchema() {
        return this;
    }

    @Override
    public String getName() {
        return this.name;
    }

    @Override
    public DbObjectStatus existsInDatabase() {
        StringBuilder stmt = new StringBuilder("select count(*) from information_schema.schemata where schema_name = '");
        // TODO: verify quoting rules
        stmt.append(this.name.replaceAll("'", "\\'"));
        stmt.append("'");
        return this.mysqlxSession.getDataStoreMetadata().schemaExists(this.name) ? DbObjectStatus.EXISTS : DbObjectStatus.NOT_EXISTS;
    }

    @Override
    public List getCollections() {
        return getCollections(null);
    }

    @Override
    public List getCollections(String pattern) {
        Set strTypes = Arrays.stream(new DbObjectType[] { DbObjectType.COLLECTION }).map(DatabaseObject.DbObjectType::toString)
                .collect(Collectors.toSet());
        Predicate rowFiler = r -> strTypes.contains(r.getValue(1, this.svf));
        Function rowToName = r -> r.getValue(0, this.svf);
        List objectNames = this.mysqlxSession.query(this.xbuilder.buildListObjects(this.name, pattern), rowFiler, rowToName, Collectors.toList());
        return objectNames.stream().map(this::getCollection).collect(Collectors.toList());
    }

    @Override
    public List getTables() {
        // TODO we need to consider lower_case_table_names server variable for some cases
        return getTables(null);
    }

    @Override
    public List
getTables(String pattern) { Set strTypes = Arrays.stream(new DbObjectType[] { DbObjectType.TABLE, DbObjectType.VIEW, DbObjectType.COLLECTION_VIEW }) .map(DatabaseObject.DbObjectType::toString).collect(Collectors.toSet()); Predicate rowFiler = r -> strTypes.contains(r.getValue(1, this.svf)); Function rowToName = r -> r.getValue(0, this.svf); List objectNames = this.mysqlxSession.query(this.xbuilder.buildListObjects(this.name, pattern), rowFiler, rowToName, Collectors.toList()); return objectNames.stream().map(this::getTable).collect(Collectors.toList()); } @Override public Collection getCollection(String collectionName) { return new CollectionImpl(this.mysqlxSession, this, collectionName); } @Override public Collection getCollection(String collectionName, boolean requireExists) { CollectionImpl coll = new CollectionImpl(this.mysqlxSession, this, collectionName); if (requireExists && coll.existsInDatabase() != DbObjectStatus.EXISTS) { throw new WrongArgumentException(coll.toString() + " doesn't exist"); } return coll; } @Override public Table getCollectionAsTable(String collectionName) { return getTable(collectionName); } @Override public Table getTable(String tableName) { return new TableImpl(this.mysqlxSession, this, tableName); } @Override public Table getTable(String tableName, boolean requireExists) { TableImpl table = new TableImpl(this.mysqlxSession, this, tableName); if (requireExists && table.existsInDatabase() != DbObjectStatus.EXISTS) { throw new WrongArgumentException(table.toString() + " doesn't exist"); } return table; } @Override public Collection createCollection(String collectionName) { this.mysqlxSession.query(this.xbuilder.buildCreateCollection(this.name, collectionName), new UpdateResultBuilder<>()); return new CollectionImpl(this.mysqlxSession, this, collectionName); } @Override public Collection createCollection(String collectionName, boolean reuseExisting) { try { return createCollection(collectionName); } catch (XProtocolError ex) { if (reuseExisting && ex.getErrorCode() == MysqlErrorNumbers.ER_TABLE_EXISTS_ERROR) { return getCollection(collectionName); } throw ex; } } @Override public Collection createCollection(String collectionName, CreateCollectionOptions options) { try { this.mysqlxSession.query(this.xbuilder.buildCreateCollection(this.name, collectionName, options), new UpdateResultBuilder<>()); return new CollectionImpl(this.mysqlxSession, this, collectionName); } catch (XProtocolError ex) { if (ex.getErrorCode() == MysqlErrorNumbers.ER_X_CMD_NUM_ARGUMENTS) { throw ExceptionFactory.createException(WrongArgumentException.class, Messages.getString("Schema.CreateCollection"), ex); } throw ex; } } @Override public void modifyCollection(String collectionName, ModifyCollectionOptions options) { try { this.mysqlxSession.query(this.xbuilder.buildModifyCollectionOptions(this.name, collectionName, options), new UpdateResultBuilder<>()); } catch (XProtocolError ex) { if (ex.getErrorCode() == MysqlErrorNumbers.ER_X_INVALID_ADMIN_COMMAND) { throw ExceptionFactory.createException(WrongArgumentException.class, Messages.getString("Schema.CreateCollection"), ex); } throw ex; } } @Override public boolean equals(Object other) { return other != null && other.getClass() == SchemaImpl.class && ((SchemaImpl) other).session == this.session && ((SchemaImpl) other).mysqlxSession == this.mysqlxSession && this.name.equals(((SchemaImpl) other).name); } @Override public int hashCode() { assert false : "hashCode not designed"; return 0; } @Override public String toString() { StringBuilder sb = new StringBuilder("Schema("); sb.append(ExprUnparser.quoteIdentifier(this.name)); sb.append(")"); return sb.toString(); } @Override public void dropCollection(String collectionName) { try { this.mysqlxSession.query(this.xbuilder.buildDropCollection(this.name, collectionName), new UpdateResultBuilder<>()); } catch (XProtocolError e) { // If specified object does not exist, dropX() methods succeed (no error is reported) // TODO check MySQL > 8.0.1 for built in solution, like passing ifExists to dropView if (e.getErrorCode() != MysqlErrorNumbers.ER_BAD_TABLE_ERROR) { throw e; } } } }