org.jooq.RowId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
The newest version!
/*
 * Licensed 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
 *
 *  https://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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import java.io.Serializable;
import java.sql.Types;

/**
 * A data type corresponding to JDBC's {@link Types#ROWID}.
 * 
 * In certain RDBMS, referencing a row by its ROWID may be quicker
 * than looking it up by a primary key. This can be particularly useful when
 * self joining a table in a {@link Merge} statement and comparing the two
 * versions of the table by ROWID.
 * 
 * Instances can be created using {@link Table#rowid()}.
 *
 * @author Lukas Eder
 */
public interface RowId extends Serializable {

    /**
     * Get the database implementation specific representation of this row id.
     */
    Object value();
}