com.microsoft.sqlserver.jdbc.ISQLServerBulkRecord Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mssql-jdbc Show documentation

Microsoft JDBC Driver for SQL Server. The Azure Key Vault feature in Microsoft JDBC Driver for SQL Server depends on Azure SDK for JAVA and Azure Active Directory Library For Java.

There is a newer version: 12.7.0.jre11-preview

Show newest version

/*
 * Microsoft JDBC Driver for SQL Server
 * 
 * Copyright(c) Microsoft Corporation All rights reserved.
 * 
 * This program is made available under the terms of the MIT License. See the LICENSE file in the project root for more information.
 */

package com.microsoft.sqlserver.jdbc;

import java.util.Set;

/**
 * The ISQLServerBulkRecord interface can be used to create classes that read in data from any source (such as a file) and allow a SQLServerBulkCopy
 * class to write the data to SQL Server tables.
 */
public interface ISQLServerBulkRecord {
    /**
     * Get the ordinals for each of the columns represented in this data record.
     * 
     * @return Set of ordinals for the columns.
     */
    public Set getColumnOrdinals();

    /**
     * Get the name of the given column.
     * 
     * @param column
     *            Column ordinal
     * @return Name of the column
     */
    public String getColumnName(int column);

    /**
     * Get the JDBC data type of the given column.
     * 
     * @param column
     *            Column ordinal
     * @return JDBC data type of the column
     */
    public int getColumnType(int column);

    /**
     * Get the precision for the given column.
     * 
     * @param column
     *            Column ordinal
     * @return Precision of the column
     */
    public int getPrecision(int column);

    /**
     * Get the scale for the given column.
     * 
     * @param column
     *            Column ordinal
     * @return Scale of the column
     */
    public int getScale(int column);

    /**
     * Indicates whether the column represents an identity column.
     * 
     * @param column
     *            Column ordinal
     * @return True if the column is an identity column; false otherwise.
     */
    public boolean isAutoIncrement(int column);

    /**
     * Gets the data for the current row as an array of Objects.
     * 
     * Each Object must match the Java language Type that is used to represent the indicated JDBC data type for the given column. For more
     * information, see 'Understanding the JDBC Driver Data Types' for the appropriate mappings.
     * 
     * @return The data for the row.
     * @throws SQLServerException
     *             If there are any errors in obtaining the data.
     */
    public Object[] getRowData() throws SQLServerException;

    /**
     * Advances to the next data row.
     * 
     * @return True if rows are available; false if there are no more rows
     * @throws SQLServerException
     *             If there are any errors in advancing to the next row.
     */
    public boolean next() throws SQLServerException;
}