https://github.com/pgjdbc/pgjdbc: Java JDBC 4.2 (JRE 8+) driver for PostgreSQL database (PostgreSQL Global Development Group)
  • Dave Cramer
  • Kris Jurka
  • Oliver Jowett
  • Craig Ringer
  • Vladimir Sitnikov 
/*
 * Copyright (c) 2009, PostgreSQL Global Development Group
 * See the LICENSE file in the project root for more information.
 */

package org.postgresql.copy;

import java.sql.SQLException;


Copy bulk data from client into a PostgreSQL table very fast.

/**
 * Copy bulk data from client into a PostgreSQL table very fast.
 */
public interface CopyIn extends CopyOperation {

  
Writes specified part of given byte array to an open and writable copy operation.

Params:
  • buf – array of bytes to write
  • off – offset of first byte to write (normally zero)
  • siz – number of bytes to write (normally buf.length)
Throws:
/**
   * Writes specified part of given byte array to an open and writable copy operation.
   *
   * @param buf array of bytes to write
   * @param off offset of first byte to write (normally zero)
   * @param siz number of bytes to write (normally buf.length)
   * @throws SQLException if the operation fails
   */
  void writeToCopy(byte[] buf, int off, int siz) throws SQLException;

  
Force any buffered output to be sent over the network to the backend. In general this is a
useless operation as it will get pushed over in due time or when endCopy is called. Some
specific modified server versions (Truviso) want this data sooner. If you are unsure if you
need to use this method, don't.

Throws:
  • SQLException – if the operation fails.
/**
   * Force any buffered output to be sent over the network to the backend. In general this is a
   * useless operation as it will get pushed over in due time or when endCopy is called. Some
   * specific modified server versions (Truviso) want this data sooner. If you are unsure if you
   * need to use this method, don't.
   *
   * @throws SQLException if the operation fails.
   */
  void flushCopy() throws SQLException;

  
Finishes copy operation successfully.

Throws:
Returns:number of updated rows for server 8.2 or newer (see getHandledRowCount())
/**
   * Finishes copy operation successfully.
   *
   * @return number of updated rows for server 8.2 or newer (see getHandledRowCount())
   * @throws SQLException if the operation fails.
   */
  long endCopy() throws SQLException;
}