org.apache.camel.component.sql.SqlConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-sql Show documentation
Camel SQL support
The newest version!
/*
 * 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.camel.component.sql;

import org.apache.camel.spi.Metadata;

/**
 * SQL Constants.
 */
public final class SqlConstants {

    @Metadata(label = "producer", description = "Query to execute. This query takes precedence over the\n" +
                                                "query specified in the endpoint URI. Note that query parameters in the\n" +
                                                "header _are_ represented by a `?` instead of a `pass:[#]` symbol",
              javaType = "String")
    public static final String SQL_QUERY = "CamelSqlQuery";
    @Metadata(label = "producer", description = "The number of rows updated for `update` operations, returned as an\n" +
                                                "`Integer` object. This header is not provided when using\n" +
                                                "outputType=StreamList.",
              javaType = "Integer")
    public static final String SQL_UPDATE_COUNT = "CamelSqlUpdateCount";
    @Metadata(label = "producer", description = "The number of rows returned for `select` operations, returned as an\n" +
                                                "`Integer` object. This header is not provided when using\n" +
                                                "outputType=StreamList.",
              javaType = "Integer")
    public static final String SQL_ROW_COUNT = "CamelSqlRowCount";

    /**
     * Boolean input header. Set its value to true to retrieve generated keys, default is false
     */
    @Metadata(label = "producer", description = "Set its value to true to retrieve generated keys", javaType = "Boolean",
              defaultValue = "false")
    public static final String SQL_RETRIEVE_GENERATED_KEYS = "CamelSqlRetrieveGeneratedKeys";

    /**
     * String[] or int[] input header - optional Set it to specify the expected generated columns,
     * see:
     *
     * @see 
     *      java.sql.Statement.execute(java.lang.String, int[])
     * @see 
     *      java.sql.Statement.execute(java.lang.String, java.lang.String[])
     */
    @Metadata(label = "producer", description = "Set it to specify the expected generated columns",
              javaType = "String[] or int[]")
    public static final String SQL_GENERATED_COLUMNS = "CamelSqlGeneratedColumns";

    /**
     * int output header giving the number of rows of generated keys
     */
    @Metadata(label = "producer", description = "The number of rows in the header that contains generated keys.",
              javaType = "Integer")
    public static final String SQL_GENERATED_KEYS_ROW_COUNT = "CamelSqlGeneratedKeysRowCount";

    /**
     * List> output header containing the generated keys retrieved
     */
    @Metadata(label = "producer", description = "Rows that contains the generated keys (a list of maps of keys).",
              javaType = "List>")
    public static final String SQL_GENERATED_KEYS_DATA = "CamelSqlGeneratedKeyRows";

    /**
     * The SQL parameters when using the option useMessageBodyForSql
     */
    @Metadata(label = "producer", javaType = "Iterator")
    public static final String SQL_PARAMETERS = "CamelSqlParameters";

    private SqlConstants() {
        // Utility class
    }
}