Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Core] Support alter database #4700

Merged
merged 20 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/content/flink/sql-alter.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,19 @@ The following SQL modifies the watermark strategy to `ts - INTERVAL '2' HOUR`.
```sql
ALTER TABLE my_table MODIFY WATERMARK FOR ts AS ts - INTERVAL '2' HOUR
```

# ALTER DATABASE

The following SQL sets one or more properties in the specified database. If a particular property is already set in the database, override the old value with the new one.

```sql
ALTER DATABASE [catalog_name.]db_name SET (key1=val1, key2=val2, ...)
Copy link
Contributor

@JingsongLi JingsongLi Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add example to alter comment and location.

Copy link
Contributor Author

@jerry-024 jerry-024 Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As in flink sql couldn't alter comment for the database, so we could only alter the location.

```

## Altering Database Location

The following SQL changes location of database `my_database` to `file:/temp/my_database`.

```sql
ALTER DATABASE my_database SET ('location' = 'file:/temp/my_database')
```
26 changes: 25 additions & 1 deletion docs/content/program-api/catalog-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public class ListDatabases {

## Drop Database

You can use the catalog to drop databases.
You can use the catalog to drop database.

```java
import org.apache.paimon.catalog.Catalog;
Expand All @@ -102,6 +102,30 @@ public class DropDatabase {
}
```

## Alter Database
JingsongLi marked this conversation as resolved.
Show resolved Hide resolved

You can use the catalog to alter database's properties.(ps: only support hive and jdbc catalog)

```java
import java.util.ArrayList;
import org.apache.paimon.catalog.Catalog;

public class AlterDatabase {

public static void main(String[] args) {
try {
Catalog catalog = CreateCatalog.createHiveCatalog();
List<DatabaseChange> changes = new ArrayList<>();
changes.add(DatabaseChange.setProperty("k1", "v1"));
changes.add(DatabaseChange.removeProperty("k2"));
catalog.alterDatabase("my_db", changes, true);
} catch (Catalog.DatabaseNotExistException e) {
// do something
}
}
}
```

## Determine Whether Table Exists

You can use the catalog to determine whether the table exists
Expand Down
18 changes: 18 additions & 0 deletions docs/content/spark/sql-alter.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,21 @@ The following SQL changes the type of a nested column `f2` to `BIGINT` in a stru
-- column v previously has type MAP<INT, STRUCT<f1: STRING, f2: INT>>
ALTER TABLE my_table ALTER COLUMN v.value.f2 TYPE BIGINT;
```


# ALTER DATABASE

The following SQL sets one or more properties in the specified database. If a particular property is already set in the database, override the old value with the new one.

```sql
ALTER { DATABASE | SCHEMA | NAMESPACE } my_database
Copy link
Contributor

@JingsongLi JingsongLi Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add example to alter comment and location.

SET { DBPROPERTIES | PROPERTIES } ( property_name = property_value [ , ... ] )
```

## Altering Database Location

The following SQL sets the location of the specified database to `file:/temp/my_database.db`.

```sql
ALTER DATABASE my_database SET LOCATION 'file:/temp/my_database.db'
```
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,26 @@ public void dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade

protected abstract void dropDatabaseImpl(String name);

@Override
public void alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists)
throws DatabaseNotExistException {
checkNotSystemDatabase(name);
try {
if (changes == null || changes.isEmpty()) {
return;
}
alterDatabaseImpl(name, changes);
} catch (DatabaseNotExistException e) {
if (ignoreIfNotExists) {
return;
}
throw new DatabaseNotExistException(name);
}
}

protected abstract void alterDatabaseImpl(String name, List<PropertyChange> changes)
throws DatabaseNotExistException;

@Override
public List<String> listTables(String databaseName) throws DatabaseNotExistException {
if (isSystemDatabase(databaseName)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,13 @@ public void dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade
}
}

@Override
public void alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists)
throws DatabaseNotExistException {
super.alterDatabase(name, changes, ignoreIfNotExists);
databaseCache.invalidate(name);
}

@Override
public void dropTable(Identifier identifier, boolean ignoreIfNotExists)
throws TableNotExistException {
Expand Down
13 changes: 13 additions & 0 deletions paimon-core/src/main/java/org/apache/paimon/catalog/Catalog.java
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,19 @@ void createDatabase(String name, boolean ignoreIfExists, Map<String, String> pro
void dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade)
throws DatabaseNotExistException, DatabaseNotEmptyException;

/**
* Alter a database.
*
* @param name Name of the database to alter.
* @param changes the property changes
* @param ignoreIfNotExists Flag to specify behavior when the database does not exist: if set to
* false, throw an exception, if set to true, do nothing.
* @throws DatabaseNotExistException if the given database is not exist and ignoreIfNotExists is
* false
*/
void alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists)
throws DatabaseNotExistException;

/**
* Return a {@link Table} identified by the given {@link Identifier}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ public void dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade
wrapped.dropDatabase(name, ignoreIfNotExists, cascade);
}

@Override
public void alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists)
throws DatabaseNotExistException {
wrapped.alterDatabase(name, changes, ignoreIfNotExists);
}

@Override
public List<String> listTables(String databaseName) throws DatabaseNotExistException {
return wrapped.listTables(databaseName);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ protected void dropDatabaseImpl(String name) {
uncheck(() -> fileIO.delete(newDatabasePath(name), true));
}

@Override
protected void alterDatabaseImpl(String name, List<PropertyChange> changes) {
throw new UnsupportedOperationException("Alter database is not supported.");
}

@Override
protected List<String> listTablesImpl(String databaseName) {
return uncheck(() -> listTablesInFileSystem(newDatabasePath(databaseName)));
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
/*
* 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.paimon.catalog;

import org.apache.paimon.utils.Pair;

import org.apache.paimon.shade.guava30.com.google.common.collect.Maps;
import org.apache.paimon.shade.guava30.com.google.common.collect.Sets;

import java.util.List;
import java.util.Map;
import java.util.Set;

/** define change to the database property. */
public interface PropertyChange {

static PropertyChange setProperty(String property, String value) {
return new SetProperty(property, value);
}

static PropertyChange removeProperty(String property) {
return new RemoveProperty(property);
}

static Pair<Map<String, String>, Set<String>> getSetPropertiesToRemoveKeys(
List<PropertyChange> changes) {
Map<String, String> setProperties = Maps.newHashMap();
Set<String> removeKeys = Sets.newHashSet();
changes.forEach(
change -> {
if (change instanceof PropertyChange.SetProperty) {
PropertyChange.SetProperty setProperty =
(PropertyChange.SetProperty) change;
setProperties.put(setProperty.property(), setProperty.value());
} else {
removeKeys.add(((PropertyChange.RemoveProperty) change).property());
}
});
return Pair.of(setProperties, removeKeys);
}

/** Set property for database change. */
final class SetProperty implements PropertyChange {

private final String property;
private final String value;

private SetProperty(String property, String value) {
this.property = property;
this.value = value;
}

public String property() {
return this.property;
}

public String value() {
return this.value;
}
}

/** Remove property for database change. */
final class RemoveProperty implements PropertyChange {

private final String property;

private RemoveProperty(String property) {
this.property = property;
}

public String property() {
return this.property;
}
}
}
45 changes: 45 additions & 0 deletions paimon-core/src/main/java/org/apache/paimon/jdbc/JdbcCatalog.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.paimon.catalog.CatalogLockFactory;
import org.apache.paimon.catalog.Database;
import org.apache.paimon.catalog.Identifier;
import org.apache.paimon.catalog.PropertyChange;
import org.apache.paimon.fs.FileIO;
import org.apache.paimon.fs.Path;
import org.apache.paimon.operation.Lock;
Expand All @@ -33,11 +34,13 @@
import org.apache.paimon.schema.SchemaChange;
import org.apache.paimon.schema.SchemaManager;
import org.apache.paimon.schema.TableSchema;
import org.apache.paimon.utils.Pair;
import org.apache.paimon.utils.Preconditions;

import org.apache.paimon.shade.guava30.com.google.common.collect.ImmutableMap;
import org.apache.paimon.shade.guava30.com.google.common.collect.Lists;
import org.apache.paimon.shade.guava30.com.google.common.collect.Maps;
import org.apache.paimon.shade.guava30.com.google.common.collect.Sets;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand All @@ -52,12 +55,15 @@
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

import static org.apache.paimon.jdbc.JdbcCatalogLock.acquireTimeout;
import static org.apache.paimon.jdbc.JdbcCatalogLock.checkMaxSleep;
import static org.apache.paimon.jdbc.JdbcUtils.deleteProperties;
import static org.apache.paimon.jdbc.JdbcUtils.execute;
import static org.apache.paimon.jdbc.JdbcUtils.insertProperties;
import static org.apache.paimon.jdbc.JdbcUtils.updateProperties;
import static org.apache.paimon.jdbc.JdbcUtils.updateTable;

/* This file is based on source code from the Iceberg Project (http://iceberg.apache.org/), licensed by the Apache
Expand Down Expand Up @@ -197,6 +203,45 @@ protected void dropDatabaseImpl(String name) {
execute(connections, JdbcUtils.DELETE_ALL_DATABASE_PROPERTIES_SQL, catalogKey, name);
}

@Override
protected void alterDatabaseImpl(String name, List<PropertyChange> changes) {
Pair<Map<String, String>, Set<String>> setPropertiesToRemoveKeys =
PropertyChange.getSetPropertiesToRemoveKeys(changes);
Map<String, String> setProperties = setPropertiesToRemoveKeys.getLeft();
Set<String> removeKeys = setPropertiesToRemoveKeys.getRight();
Map<String, String> startingProperties = fetchProperties(name);
Map<String, String> inserts = Maps.newHashMap();
Map<String, String> updates = Maps.newHashMap();
Set<String> removes = Sets.newHashSet();
if (!setProperties.isEmpty()) {
setProperties.forEach(
(k, v) -> {
if (!startingProperties.containsKey(k)) {
inserts.put(k, v);
} else {
updates.put(k, v);
}
});
}
if (!removeKeys.isEmpty()) {
removeKeys.forEach(
k -> {
if (startingProperties.containsKey(k)) {
removes.add(k);
}
});
}
if (!inserts.isEmpty()) {
insertProperties(connections, catalogKey, name, inserts);
}
if (!updates.isEmpty()) {
updateProperties(connections, catalogKey, name, updates);
}
if (!removes.isEmpty()) {
deleteProperties(connections, catalogKey, name, removes);
}
}

@Override
protected List<String> listTablesImpl(String databaseName) {
return fetch(
Expand Down
Loading
Loading