extensions/entitystore-sqlkv/src/main/java/org/apache/polygene/entitystore/sql/SQLEntityStoreConfiguration.java

/*
 *  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.polygene.entitystore.sql;

import org.apache.polygene.api.common.UseDefaults;
import org.apache.polygene.api.property.Property;
import org.apache.polygene.library.sql.common.SQLConfiguration;

// START SNIPPET: config
public interface SQLEntityStoreConfiguration extends SQLConfiguration
{
    /**
     * Name of the database schema to use.
     * Ignored on SQL databases that don't support schemas.
     */
    @UseDefaults( "POLYGENE_ES" )
    @Override
    Property<String> schemaName();

    /**
     * Name of the entities table.
     */
    @UseDefaults( "POLYGENE_ENTITIES" )
    Property<String> entityTableName();

    /**
     * Defines whether the database schema and table should be created if not already present.
     */
    @UseDefaults( "true" )
    Property<Boolean> createIfMissing();
}
// END SNIPPET: config