[
https://issues.apache.org/jira/browse/HIVE-27186?focusedWorklogId=857935&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-857935
]
ASF GitHub Bot logged work on HIVE-27186:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 19/Apr/23 12:42
Start Date: 19/Apr/23 12:42
Worklog Time Spent: 10m
Work Description: dengzhhu653 commented on code in PR #4194:
URL: https://github.com/apache/hive/pull/4194#discussion_r1171281173
##########
standalone-metastore/metastore-common/src/main/java/org/apache/hadoop/hive/metastore/properties/PropertyManager.java:
##########
@@ -0,0 +1,576 @@
+/*
+ * 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.hadoop.hive.metastore.properties;
+
+
+import org.apache.commons.jexl3.JexlBuilder;
+import org.apache.commons.jexl3.JexlContext;
+import org.apache.commons.jexl3.JexlEngine;
+import org.apache.commons.jexl3.JexlException;
+import org.apache.commons.jexl3.JexlExpression;
+import org.apache.commons.jexl3.JexlFeatures;
+import org.apache.commons.jexl3.introspection.JexlPermissions;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.lang.reflect.Constructor;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Properties;
+import java.util.TreeMap;
+import java.util.UUID;
+import java.util.function.Function;
+
+/**
+ * A property manager.
+ * <p>
+ * This handles operations at the higher functional level; an instance is
created per-session and
+ * drives queries and updates in a transactional manner.
+ * </p>
+ * <p>
+ * The manager ties the property schemas into one namespace; all property maps
it handles must and will use
+ * one of its known schema.
+ * </p>
+ */
+public abstract class PropertyManager {
+ /** The logger. */
+ public static final Logger LOGGER =
LoggerFactory.getLogger(PropertyManager.class);
+ /** The set of dirty maps. */
+ protected Map<String, PropertyMap> dirtyMaps = new HashMap<>();
+ /** This manager namespace. */
+ protected final String namespace;
+ /** The property map store. */
+ protected final PropertyStore store;
+ /** A Jexl engine for convenience. */
+ static final JexlEngine JEXL;
+ static {
+ JexlFeatures features = new JexlFeatures()
+ .sideEffect(false)
+ .sideEffectGlobal(false);
+ JexlPermissions p = JexlPermissions.RESTRICTED
+ .compose("org.apache.hadoop.hive.metastore.properties.*");
+ JEXL = new JexlBuilder()
+ .features(features)
+ .permissions(p)
+ .create();
+ }
+
+ /**
+ * The map of defined managers.
+ */
+ private static final Map<String, Constructor<? extends PropertyManager>>
NSMANAGERS = new HashMap<>();
+
+ /**
+ * Declares a property manager class.
+ * @param ns the namespace
+ * @param pmClazz the property mamanger class
+ */
+ public static boolean declare(String ns, Class<? extends PropertyManager>
pmClazz) {
+ try {
+ synchronized(NSMANAGERS) {
+ Constructor<? extends PropertyManager> ctor = NSMANAGERS.get(ns);
+ if (ctor == null) {
+ ctor = pmClazz.getConstructor(String.class, PropertyStore.class);
+ NSMANAGERS.put(ns, ctor);
+ return true;
+ } else {
+ if (!Objects.equals(ctor.getDeclaringClass(), pmClazz)) {
+ LOGGER.error("namespace {} is already declared for {}", ns,
pmClazz.getCanonicalName());
+ }
+ }
+ }
+ } catch(NoSuchMethodException xnom ) {
+ LOGGER.error("namespace declaration failed: " + ns + ", " +
pmClazz.getCanonicalName(),
+ xnom);
+ }
+ return false;
+ }
+
+ /**
+ * Creates an instance of manager using its declared namespace.
+ * @param namespace the manager"s namespace
+ * @param store the property store
+ * @return a property manager instance
+ */
+ public static PropertyManager create(String namespace, PropertyStore store) {
+ final Constructor<? extends PropertyManager> ctor;
+ synchronized(NSMANAGERS) {
+ ctor = NSMANAGERS.get(namespace);
+ }
+ if (ctor != null) {
+ try {
+ return ctor.newInstance(namespace, store);
+ } catch(Exception xany) {
+ LOGGER.error("property manager creation failed "+ namespace, xany);
+ }
+ } else {
+ LOGGER.error("no such property manager namespace is declared " +
namespace);
+ }
+ return null;
+ }
+
+ /**
+ * JEXL adapter.
+ */
+ public static class MapWrapper implements JexlContext {
+ PropertyMap map;
+ MapWrapper(PropertyMap map) {
+ this.map = map;
+ }
+
+ public Object get(String p) {
+ return map.getPropertyValue(p);
+ }
+
+ @Override
+ public void set(String name, Object value) {
+ map.putProperty(name, value);
+ }
+
+ @Override
+ public boolean has(String name) {
+ return map.getTypeOf(name) != null;
+ }
+ }
+
+ /**
+ * Creates a manager instance.
+ * @param store the store instance which must use an appropriate property
map factory (probably use createMap).
+ */
+ protected PropertyManager(String ns, PropertyStore store) {
+ this.namespace = ns;
+ this.store = store;
+ }
+
+ /**
+ * Saves all pending updates to store.
+ */
+ public void commit() {
+ final Map<String, PropertyMap> dirtyMaps = this.dirtyMaps;
+ synchronized(dirtyMaps) {
+ if (!dirtyMaps.isEmpty()) {
+ store.saveProperties(dirtyMaps.entrySet().iterator());
+ dirtyMaps.clear();
+ }
+ }
+ }
+
+ /**
+ * Forget all pending updates.
+ */
+ public void rollback() {
+ final Map<String, PropertyMap> dirtyMaps = this.dirtyMaps;
+ synchronized(dirtyMaps) {
+ dirtyMaps.clear();
+ }
+ }
+
+ /**
+ * Imports a set of default values into this store"s schema.
+ * The properties should be of the form schema_name.property_name=value.
+ * Note that this implies the manager has at least one known property map
schema.
+ * @param importsp the properties
+ */
+ public void importDefaultValues(Properties importsp) {
+ importsp.forEach((k, v)->{
+ String importName = k.toString();
+ final int dotPosition = importName.indexOf(".");
+ if (dotPosition > 0) {
+ String schemaName = importName.substring(0, dotPosition);
+ PropertySchema schema = getSchema(schemaName);
+ if (schema != null) {
+ String propertyName = importName.substring(dotPosition + 1);
+ schema.setDefaultValue(propertyName, v);
+ }
+ }
+ });
+ }
+
+ /**
+ * Imports a set of property values.
+ * @param map the properties key=value
+ */
+ public void setProperties(Properties map) {
+ map.forEach((k, v)-> setProperty(k.toString(), v));
+ }
+
+ /**
+ * Injects a set of properties.
+ * If the value is null, the property is removed.
+ * @param map the map of properties to inject.
+ */
+ public void setProperties(Map<String, Object> map) {
+ map.forEach(this::setProperty);
+ }
+
+ /**
+ * Sets a property value.
+ * @param key the property key
+ * @param value the property value or null to unset
+ */
+ public void setProperty(String key, Object value) {
+ setProperty(splitKey(key), value);
+ }
+
+ /**
+ * Gets a property value.
+ * @param key the property key
+ * @return property value or null if not assigned
+ */
+ public Object getProperty(String key) {
+ return getProperty(splitKey(key));
+ }
+
+ /**
+ * Gets a property value.
+ * @param key the property key
+ * @return property value or the schema default value if not assigned
+ */
+ public Object getPropertyValue(String key) {
+ return getPropertyValue(splitKey(key));
+ }
+
+ /**
+ * Splits a property key into its fragments.
+ * @param key the property key
+ * @return the key fragments
+ */
+ protected String[] splitKey(String key) {
+ String[] splits = key.split("(?<!\\\\)\\.");
+ if (splits.length < 1) {
+ splits = new String[]{key};
+ }
+ return splits;
+ }
+
+ /**
+ * Gets a schema by name.
+ * <p>Only used by {@link #importDefaultValues(Properties)}</p>
+ * @param name schema name
+ * @return the schema instance, null if no such schema is known
+ */
+ public PropertySchema getSchema(String name) {
+ return null;
+ }
+
+ /**
+ * Determines the schema from the property key fragments.
+ * @param keys the key fragments
+ * @return the schema, {@link PropertySchema#NONE} if no such schema is known
+ */
+ protected PropertySchema schemaOf(String[] keys) {
+ return PropertySchema.NONE;
+ }
+
+ /**
+ * @param keys property key fragments
+ * @return number of fragments composing the map name in the fragments array
+ */
+ protected int getMapNameLength(String[] keys) {
+ return keys.length - 1;
+ }
+
+ /**
+ * Compose a property map key from a property map name.
+ * @param name the property map name, may be null or empty
+ * @return the property map key used by the store
+ */
+ protected String mapKey(String name) {
+ StringBuilder strb = new StringBuilder(namespace);
+ if (name != null && !name.isEmpty()){
+ strb.append('.');
+ strb.append(name);
+ }
+ return strb.toString();
+ }
+
+ /**
+ * Extract a property map name from a property map key.
+ * @param key property map key
+ * @return the property map name
+ */
+ protected String mapName(String key) {
+ int dot = key.indexOf('.');
+ return dot > 0? key.substring(dot + 1) : key;
+ }
+
+ /**
+ * Compose a property map key from property key fragments.
+ * @param keys the key fragments
+ * @return the property map key used by the store
+ */
+ protected String mapKey(String[] keys) {
+ return mapKey(keys, getMapNameLength(keys));
+ }
+
+ /**
+ * Compose a property map key from property key fragments.
+ * @param keys the property key fragments
+ * @param maxkl the maximum number of fragments in the map key
+ * @return the property key used by the store
+ */
+ protected String mapKey(String[] keys, int maxkl) {
+ if (keys.length < 1) {
+ throw new IllegalArgumentException("at least 1 key fragments expected");
+ }
+ // shortest map key is namespace
+ StringBuilder strb = new StringBuilder(namespace);
+ for(int k = 0; k < Math.min(maxkl, keys.length - 1); ++k) {
+ strb.append('.');
+ strb.append(keys[k]);
+ }
+ return strb.toString();
+ }
+
+ /**
+ * Compose a property name from property key fragments.
+ * @param keys the key fragments
+ * @return the property name
+ */
+ protected String propertyName(String[] keys) {
+ return propertyName(keys, getMapNameLength(keys));
+ }
+
+ /**
+ * Compose a property name from property key fragments.
+ * @param keys the key fragments
+ * @param maxkl the maximum number of fragments in the map name
+ * @return the property name
+ */
+ protected String propertyName(String[] keys, int maxkl) {
+ if (keys.length < 1) {
+ throw new IllegalArgumentException("at least 1 key fragments expected");
+ }
+ if (keys.length <= maxkl) {
+ return keys[keys.length - 1];
+ }
+ StringBuilder strb = new StringBuilder(keys[maxkl]);
+ for(int k = maxkl + 1; k < keys.length; ++k) {
+ strb.append('.');
+ strb.append(keys[k]);
+ }
+ return strb.toString();
+ }
+
+ /**
+ * Gets a property value.
+ * @param keys the key fragments
+ * @return the value or null if none was assigned
+ */
+ public Object getProperty(String[] keys) {
+ final String mapKey = mapKey(keys);
+ PropertyMap map;
+ final Map<String, PropertyMap> dirtyMaps = this.dirtyMaps;
+ synchronized(dirtyMaps) {
+ map = dirtyMaps.get(mapKey);
+ }
+ if (map == null) {
+ map = store.fetchProperties(mapKey, null);
+ }
+ if (map != null) {
+ return map.getProperty(propertyName(keys));
+ }
+ return null;
+ }
+
+ /**
+ * Gets a property value.
+ * @param keys the key fragments
+ * @return the value or the default schema value if not assigned
+ */
+ public Object getPropertyValue(String[] keys) {
+ final String mapKey = mapKey(keys);
+ PropertyMap map;
+ final Map<String, PropertyMap> dirtyMaps = this.dirtyMaps;
+ synchronized(dirtyMaps) {
+ map = dirtyMaps.get(mapKey);
+ }
+ PropertySchema schema = schemaOf(keys);
+ if (map == null) {
+ map = store.fetchProperties(mapKey, s->schema);
+ }
+ String propertyName = propertyName(keys);
+ if (map != null) {
+ return map.getPropertyValue(propertyName);
+ }
+ if (schema != null) {
+ return schema.getDefaultValue(propertyName);
+ }
+ return null;
+ }
+
+ /**
+ * Drops a property map.
+ * @param mapName the map name
+ * @return true if the properties may exist, false if they did nots
+ */
+ public boolean dropProperties(String mapName) {
+ final String mapKey = mapKey(mapName);
+ PropertyMap dirtyMap;
+ final Map<String, PropertyMap> dirtyMaps = this.dirtyMaps;
+ synchronized (dirtyMaps) {
+ dirtyMap = dirtyMaps.get(mapKey);
+ }
+ PropertyMap map;
+ if (dirtyMap != null && Objects.equals(PropertyMap.DROPPED,
dirtyMap.getDigest())) {
+ map = dirtyMap;
+ } else {
+ // is is stored ?
+ UUID digest = store.fetchDigest(mapKey);
+ // not stored nor cached, nothing to do
+ if (digest == null) {
+ return false;
+ }
+ map = new PropertyMap(store, schemaOf(splitKey(mapName + ".*")),
PropertyMap.DROPPED);
+ synchronized (dirtyMaps) {
+ dirtyMaps.put(mapName, map);
+ }
+ }
+ // if this is the first update to the map
+ if (map != dirtyMap) {
+ dirtyMaps.put(mapName, map);
+ }
+ return false;
+ }
+
+ /**
+ * Sets a property value.
+ * @param keys the key fragments
+ * @param value the new value or null if mapping should be removed
+ */
+ public void setProperty(String[] keys, Object value) {
+ // find schema from key (length)
+ PropertySchema schema = schemaOf(keys);
+ String mapKey = mapKey(keys);
+ PropertyMap dirtyMap;
+ final Map<String, PropertyMap> dirtyMaps = this.dirtyMaps;
+ synchronized (dirtyMaps) {
+ dirtyMap = dirtyMaps.get(mapKey);
+ }
+ PropertyMap map;
+ if (dirtyMap != null) {
+ map = dirtyMap;
+ } else {
+ // is is stored ?
+ map = store.fetchProperties(mapKey, s->schema);
+ if (map == null) {
+ // remove a value from a non persisted map, noop
+ if (value == null) {
+ return;
+ }
+ map = new PropertyMap(store, schema);
+ }
+ }
+ // map is not null
+ String propertyName = propertyName(keys);
+ if (value != null) {
+ map.putProperty(propertyName, value);
+ } else {
+ map.removeProperty(propertyName);
+ }
+ // if this is the first update to the map
+ if (map != dirtyMap) {
+ dirtyMaps.put(mapKey, map);
+ }
+ }
+
+ public Map<String, PropertyMap> selectProperties(String namePrefix, String
predicateStr, String... projectStr) {
+ return selectProperties(namePrefix, predicateStr,
+ projectStr == null
+ ? Collections.emptyList()
+ : Arrays.asList(projectStr));
+ }
+
+ /**
+ * Selects a set of properties.
+ * @param mapPrefix the map name prefix
+ * @param selector the selector/transformer function
+ * @return the map of property maps keyed by their name
+ */
+ public Map<String, PropertyMap> selectProperties(String mapPrefix,
Function<PropertyMap, PropertyMap> selector) {
+ final String mapKey = mapKey(mapPrefix);
+ final Map<String, PropertyMap> selected =
store.selectProperties(mapKey,null, k->schemaOf(splitKey(k)) );
+ final Map<String, PropertyMap> maps = new TreeMap<>();
+ final Function<PropertyMap, PropertyMap> transform = selector == null?
Function.identity() : selector;
+ selected.forEach((k, p) -> {
+ final PropertyMap dirtyMap = dirtyMaps.get(k);
+ final PropertyMap map = transform.apply(dirtyMap == null ? p.copy() :
dirtyMap.copy());
+ if (map != null && !map.isEmpty()) {
+ maps.put(mapName(k), map);
+ }
+ });
+ return maps;
+ }
+ public Map<String, PropertyMap> selectProperties(String prefix, String
predicateStr, List<String> projectStr) {
+ final JexlExpression predicate;
+ try {
+ predicate = JEXL.createExpression(predicateStr);
+ } catch(JexlException.Parsing xparse) {
+ if (LOGGER.isDebugEnabled()) {
+ LOGGER.debug(predicateStr, xparse);
+ }
+ throw xparse;
+ }
+ final Function<PropertyMap, PropertyMap> transform = (map)->{
+ MapWrapper wrapped = new MapWrapper(map);
+ Object result;
+ try {
+ result = predicate.evaluate(wrapped);
Review Comment:
Not sure if it will bring potential security problem provided that the
`predicateStr` can be arbitrary.
Issue Time Tracking
-------------------
Worklog Id: (was: 857935)
Time Spent: 3h (was: 2h 50m)
> A persistent property store
> ----------------------------
>
> Key: HIVE-27186
> URL: https://issues.apache.org/jira/browse/HIVE-27186
> Project: Hive
> Issue Type: Improvement
> Components: Metastore
> Affects Versions: 4.0.0-alpha-2
> Reporter: Henri Biestro
> Assignee: Henri Biestro
> Priority: Major
> Labels: pull-request-available
> Time Spent: 3h
> Remaining Estimate: 0h
>
> WHAT
> A persistent property store usable as a support facility for any metadata
> augmentation feature.
> WHY
> When adding new meta-data oriented features, we usually need to persist
> information linking the feature data and the HiveMetaStore objects it applies
> to. Any information related to a database, a table or the cluster - like
> statistics for example or any operational data state or data (think rolling
> backup) - fall in this use-case.
> Typically, accommodating such a feature requires modifying the Metastore
> database schema by adding or altering a table. It also usually implies
> modifying the thrift APIs to expose such meta-data to consumers.
> The proposed feature wants to solve the persistence and query/transport for
> these types of use-cases by exposing a 'key/(meta)value' store exposed as a
> property system.
> HOW
> A property-value model is the simple and generic exposed API.
> To provision for several usage scenarios, the model entry point is a
> 'namespace' that qualifies the feature-component property manager. For
> example, 'stats' could be the namespace for all properties related to the
> 'statistics' feature.
> The namespace identifies a manager that handles property-groups persisted as
> property-maps. For instance, all statistics pertaining to a given table would
> be collocated in the same property-group. As such, all properties (say number
> of 'unique_values' per columns) for a given HMS table 'relation0' would all
> be stored and persisted in the same property-map instance.
> Property-maps may be decorated by an (optional) schema that may declare the
> name and value-type of allowed properties (and their optional default value).
> Each property is addressed by a name, a path uniquely identifying the
> property in a given property map.
> The manager also handles transforming property-map names to the property-map
> keys used to persist them in the DB.
> The API provides inserting/updating properties in bulk transactionally. It
> also provides selection/projection to help reduce the volume of exchange
> between client/server; selection can use (JEXL expression) predicates to
> filter maps.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
