H2 Database Engine 2.3.232 · org.h2.tools.Csv · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	caseSensitiveColumnNames
private String	characterSet
private String[]	columnNames
private boolean	endOfFile
private boolean	endOfLine
private char	escapeCharacter
private char	fieldDelimiter
private char	fieldSeparatorRead
private String	fieldSeparatorWrite
private String	fileName
private BufferedReader	input
private char[]	inputBuffer
private int	inputBufferEnd
private int	inputBufferPos
private int	inputBufferStart
private char	lineComment
private String	lineSeparator
private String	nullString
private Writer	output
private boolean	preserveWhitespace
private boolean	quotedNulls
private boolean	writeColumnHeader

Access	Constructor and Description
public	Csv()

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.h2.tools.SimpleRowSource.close. INTERNAL
private static SQLException	convertException(String message, Exception e)
private String	escape(String data)
public boolean	Returns: whether column names are case sensitive getCaseSensitiveColumnNames() Get the current case sensitive column names setting.
public char	Returns: the escape character getEscapeCharacter() Get the current escape character.
public char	Returns: the field delimiter getFieldDelimiter() Get the current field delimiter.
public char	Returns: the field separator getFieldSeparatorRead() Get the current field separator for reading.
public String	Returns: the field separator getFieldSeparatorWrite() Get the current field separator for writing.
public char	Returns: the line comment character, or 0 if disabled getLineCommentCharacter() Get the line comment character.
public String	Returns: the line separator getLineSeparator() Get the line separator used for writing.
public String	Returns: the null string. getNullString() Get the current null string.
public boolean	Returns: the current value for the setting getPreserveWhitespace() Whether whitespace in unquoted text is preserved.
public boolean	Returns: the current value for the setting getWriteColumnHeader() Whether the column header is written.
private void	init(String newFileName, String charset)
private void	initRead()
private void	initWrite()
private static boolean	isParam(String key, String... values)
public boolean	Returns: True if the null values are quoted. isQuotedNulls() Returns true if the `null values` are quoted.
private static boolean	isSimpleColumnName(String columnName)
private void	makeColumnNamesUnique()
private void	pushBack()
public ResultSet	Returns: the result set read(String the file name inputFileName, String[] or null if the column names should be read from the CSV file colNames, String the charset or null to use the system default charset charset) Reads from the CSV file and returns a result set.
public ResultSet	Returns: the result set read(Reader the reader reader, String[] or null if the column names should be read from the CSV file colNames) Reads CSV data from a reader and returns a result set.
private int	readBuffer()
private int	readChar()
private void	readHeader()
private String	readNull(String s)
private ResultSet	readResultSet(String[] colNames)
public Object[]	readRow() Implements org.h2.tools.SimpleRowSource.readRow. INTERNAL
private String	readValue()
public void	reset() Implements org.h2.tools.SimpleRowSource.reset. INTERNAL
public void	setCaseSensitiveColumnNames(boolean whether column names are case sensitive caseSensitiveColumnNames) Override the case sensitive column names setting.
public void	setEscapeCharacter(char the escape character escapeCharacter) Set the escape character.
public void	setFieldDelimiter(char the field delimiter fieldDelimiter) Set the field delimiter.
public void	setFieldSeparatorRead(char the field separator fieldSeparatorRead) Override the field separator for reading.
public void	setFieldSeparatorWrite(String the field separator fieldSeparatorWrite) Override the field separator for writing.
public void	setLineCommentCharacter(char the line comment character lineCommentCharacter) Set the line comment character.
public void	setLineSeparator(String the line separator lineSeparator) Set the line separator used for writing.
public void	setNullString(String the null nullString) Set the value that represents NULL.
public String	Returns: the character set setOptions(String the options options) INTERNAL.
public void	setPreserveWhitespace(boolean the new value for the setting value) Enable or disable preserving whitespace in unquoted text.
public void	setQuotedNulls(boolean True if the null values must be quoted. quotedNulls) Defines if the `null values` must be quoted.
public void	setWriteColumnHeader(boolean the new value for the setting value) Enable or disable writing the column header.
private String	unEscape(String s)
public int	Returns: the number of rows written write(Writer the writer writer, ResultSet the result set rs) Writes the result set to a file in the CSV format.
public int	Returns: the number of rows written write(String the name of the csv file outputFileName, ResultSet the result set - the result set must be positioned before the first row. rs, String the charset or null to use the system default charset charset) Writes the result set to a file in the CSV format.
public int	Returns: the number of rows written write(Connection the connection conn, String the file name outputFileName, String the query sql, String the charset or null to use the system default charset (see system property file.encoding) charset) Writes the result set of a query to a file in the CSV format.
private int	writeResultSet(ResultSet rs)
private void	writeRow(String[] values)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

caseSensitiveColumnNames	back to summary
private boolean caseSensitiveColumnNames

characterSet	back to summary
private String characterSet

columnNames	back to summary
private String[] columnNames

endOfFile	back to summary
private boolean endOfFile

endOfLine	back to summary
private boolean endOfLine

escapeCharacter	back to summary
private char escapeCharacter

fieldDelimiter	back to summary
private char fieldDelimiter

fieldSeparatorRead	back to summary
private char fieldSeparatorRead

fieldSeparatorWrite	back to summary
private String fieldSeparatorWrite

fileName	back to summary
private String fileName

input	back to summary
private BufferedReader input

inputBuffer	back to summary
private char[] inputBuffer

inputBufferEnd	back to summary
private int inputBufferEnd

inputBufferPos	back to summary
private int inputBufferPos

inputBufferStart	back to summary
private int inputBufferStart

lineComment	back to summary
private char lineComment

lineSeparator	back to summary
private String lineSeparator

nullString	back to summary
private String nullString

output	back to summary
private Writer output

preserveWhitespace	back to summary
private boolean preserveWhitespace

quotedNulls	back to summary
private boolean quotedNulls

writeColumnHeader	back to summary
private boolean writeColumnHeader

Csv	back to summary
public Csv()

Method Detail

close	back to summary
public void close() Implements org.h2.tools.SimpleRowSource.close. INTERNAL Annotations @Override

back to summary

public void close()

Implements org.h2.tools.SimpleRowSource.close.

INTERNAL

Annotations

@Override

convertException	back to summary
private static SQLException convertException(String message, Exception e)

escape	back to summary
private String escape(String data)

getCaseSensitiveColumnNames	back to summary
public boolean getCaseSensitiveColumnNames() Get the current case sensitive column names setting. Returns:boolean whether column names are case sensitive

getCaseSensitiveColumnNames

back to summary

public boolean getCaseSensitiveColumnNames()

Get the current case sensitive column names setting.

Returns:boolean: whether column names are case sensitive

getEscapeCharacter	back to summary
public char getEscapeCharacter() Get the current escape character. Returns:char the escape character

getEscapeCharacter

back to summary

public char getEscapeCharacter()

Get the current escape character.

Returns:char: the escape character

getFieldDelimiter	back to summary
public char getFieldDelimiter() Get the current field delimiter. Returns:char the field delimiter

getFieldDelimiter

back to summary

public char getFieldDelimiter()

Get the current field delimiter.

Returns:char: the field delimiter

getFieldSeparatorRead	back to summary
public char getFieldSeparatorRead() Get the current field separator for reading. Returns:char the field separator

getFieldSeparatorRead

back to summary

public char getFieldSeparatorRead()

Get the current field separator for reading.

Returns:char: the field separator

getFieldSeparatorWrite	back to summary
public String getFieldSeparatorWrite() Get the current field separator for writing. Returns:String the field separator

getFieldSeparatorWrite

back to summary

public String getFieldSeparatorWrite()

Get the current field separator for writing.

Returns:String: the field separator

getLineCommentCharacter	back to summary
public char getLineCommentCharacter() Get the line comment character. Returns:char the line comment character, or 0 if disabled

getLineCommentCharacter

back to summary

public char getLineCommentCharacter()

Get the line comment character.

Returns:char: the line comment character, or 0 if disabled

getLineSeparator	back to summary
public String getLineSeparator() Get the line separator used for writing. Returns:String the line separator

getLineSeparator

back to summary

public String getLineSeparator()

Get the line separator used for writing.

Returns:String: the line separator

getNullString	back to summary
public String getNullString() Get the current null string. Returns:String the null string.

getNullString

back to summary

public String getNullString()

Get the current null string.

Returns:String: the null string.

getPreserveWhitespace	back to summary
public boolean getPreserveWhitespace() Whether whitespace in unquoted text is preserved. Returns:boolean the current value for the setting

getPreserveWhitespace

back to summary

public boolean getPreserveWhitespace()

Whether whitespace in unquoted text is preserved.

Returns:boolean: the current value for the setting

getWriteColumnHeader	back to summary
public boolean getWriteColumnHeader() Whether the column header is written. Returns:boolean the current value for the setting

getWriteColumnHeader

back to summary

public boolean getWriteColumnHeader()

Whether the column header is written.

Returns:boolean: the current value for the setting

init	back to summary
private void init(String newFileName, String charset)

initRead	back to summary
private void initRead() throws IOException

initWrite	back to summary
private void initWrite() throws IOException

isParam	back to summary
private static boolean isParam(String key, String... values)

isQuotedNulls back to summary

isQuotedNulls	back to summary
public boolean isQuotedNulls() Returns true if the `null values` are quoted. Returns:boolean True if the null values are quoted.

public boolean isQuotedNulls()

Returns true if the null values are quoted.

Returns:boolean: True if the null values are quoted.

isSimpleColumnName	back to summary
private static boolean isSimpleColumnName(String columnName)

makeColumnNamesUnique	back to summary
private void makeColumnNamesUnique()

pushBack	back to summary
private void pushBack()

read	back to summary
public ResultSet read(String inputFileName, String[] colNames, String charset) throws SQLException Reads from the CSV file and returns a result set. The rows in the result set are created on demand, that means the file is kept open until all rows are read or the result set is closed. If the columns are read from the CSV file, then the following rules are used: columns names that start with a letter or '_', and only contain letters, '_', and digits, are considered case insensitive and are converted to uppercase. Other column names are considered case sensitive (that means they need to be quoted when accessed). Parameters inputFileName:String the file name colNames:String[] or null if the column names should be read from the CSV file charset:String the charset or null to use the system default charset Returns:ResultSet the result set Exceptions SQLException: on failure

read

back to summary

public ResultSet read(String inputFileName, String[] colNames, String charset) throws SQLException

Reads from the CSV file and returns a result set. The rows in the result set are created on demand, that means the file is kept open until all rows are read or the result set is closed. If the columns are read from the CSV file, then the following rules are used: columns names that start with a letter or '_', and only contain letters, '_', and digits, are considered case insensitive and are converted to uppercase. Other column names are considered case sensitive (that means they need to be quoted when accessed).

Parameters

inputFileName:String: the file name
colNames:String[]: or null if the column names should be read from the CSV file
charset:String: the charset or null to use the system default charset

Returns:ResultSet

the result set

Exceptions

SQLException:: on failure

read	back to summary
public ResultSet read(Reader reader, String[] colNames) throws IOException Reads CSV data from a reader and returns a result set. The rows in the result set are created on demand, that means the reader is kept open until all rows are read or the result set is closed. Parameters reader:Reader the reader colNames:String[] or null if the column names should be read from the CSV file Returns:ResultSet the result set Exceptions IOException: on failure

read

back to summary

public ResultSet read(Reader reader, String[] colNames) throws IOException

Reads CSV data from a reader and returns a result set. The rows in the result set are created on demand, that means the reader is kept open until all rows are read or the result set is closed.

Parameters

reader:Reader: the reader
colNames:String[]: or null if the column names should be read from the CSV file

Returns:ResultSet

the result set

Exceptions

IOException:: on failure

readBuffer	back to summary
private int readBuffer() throws IOException

readChar	back to summary
private int readChar() throws IOException

readHeader	back to summary
private void readHeader() throws IOException

readNull	back to summary
private String readNull(String s)

readResultSet	back to summary
private ResultSet readResultSet(String[] colNames) throws IOException

readRow

back to summary

public Object[] readRow() throws SQLException

Implements org.h2.tools.SimpleRowSource.readRow.

INTERNAL

Returns:Object[]

Doc from org.h2.tools.SimpleRowSource.readRow.

the row or null

Annotations

@Override

Exceptions

SQLException:

Doc from org.h2.tools.SimpleRowSource.readRow.

on failure

readValue	back to summary
private String readValue() throws IOException

reset

back to summary

public void reset() throws SQLException

Implements org.h2.tools.SimpleRowSource.reset.

INTERNAL

Annotations

@Override

Exceptions

SQLException:

Doc from org.h2.tools.SimpleRowSource.reset.

if this operation is not supported

setCaseSensitiveColumnNames

back to summary

public void setCaseSensitiveColumnNames(boolean caseSensitiveColumnNames)

Override the case sensitive column names setting. The default is false. If enabled, the case of all column names is always preserved.

Parameters

caseSensitiveColumnNames:boolean: whether column names are case sensitive

setEscapeCharacter

back to summary

public void setEscapeCharacter(char escapeCharacter)

Set the escape character. The escape character is used to escape the field delimiter. This is needed if the data contains the field delimiter. The default escape character is " (a double quote), which is the same as the field delimiter. If the field delimiter and the escape character are both " (double quote), and the data contains a double quote, then an additional double quote is added. Example:

Data: He said "Hello".
Escape character: "
Field delimiter: "
CSV file: "He said ""Hello""."

If the field delimiter is a double quote and the escape character is a backslash, then escaping is done similar to Java (however, only the field delimiter is escaped). Example:

Data: He said "Hello".
Escape character: \
Field delimiter: "
CSV file: "He said \"Hello\"."

The value 0 means no escape character is used.

Parameters

escapeCharacter:char: the escape character

setFieldDelimiter

back to summary

public void setFieldDelimiter(char fieldDelimiter)

Set the field delimiter. The default is " (a double quote). The value 0 means no field delimiter is used.

Parameters

fieldDelimiter:char: the field delimiter

setFieldSeparatorRead

back to summary

public void setFieldSeparatorRead(char fieldSeparatorRead)

Override the field separator for reading. The default is ','.

Parameters

fieldSeparatorRead:char: the field separator

setFieldSeparatorWrite

back to summary

public void setFieldSeparatorWrite(String fieldSeparatorWrite)

Override the field separator for writing. The default is ",".

Parameters

fieldSeparatorWrite:String: the field separator

setLineCommentCharacter

back to summary

public void setLineCommentCharacter(char lineCommentCharacter)

Set the line comment character. The default is character code 0 (line comments are disabled).

Parameters

lineCommentCharacter:char: the line comment character

setLineSeparator

back to summary

public void setLineSeparator(String lineSeparator)

Set the line separator used for writing. This is usually a line feed (\n or \r\n depending on the system settings). The line separator is written after each row (including the last row), so this option can include an end-of-row marker if needed.

Parameters

lineSeparator:String: the line separator

setNullString

back to summary

public void setNullString(String nullString)

Set the value that represents NULL. It is only used for non-delimited values.

Parameters

nullString:String: the null

setOptions

back to summary

public String setOptions(String options)

INTERNAL. Parse and set the CSV options.

Parameters

options:String: the options

Returns:String

the character set

setPreserveWhitespace

back to summary

public void setPreserveWhitespace(boolean value)

Enable or disable preserving whitespace in unquoted text.

Parameters

value:boolean: the new value for the setting

setQuotedNulls back to summary

public void setQuotedNulls(boolean quotedNulls)

Defines if the null values must be quoted.

Parameters

quotedNulls:boolean: True if the null values must be quoted.

setWriteColumnHeader

back to summary

public void setWriteColumnHeader(boolean value)

Enable or disable writing the column header.

Parameters

value:boolean: the new value for the setting

unEscape	back to summary
private String unEscape(String s)

write

back to summary

public int write(Writer writer, ResultSet rs) throws SQLException

Writes the result set to a file in the CSV format.

Parameters

writer:Writer: the writer
rs:ResultSet: the result set

Returns:int

the number of rows written

Exceptions

SQLException:: on failure

write

back to summary

public int write(String outputFileName, ResultSet rs, String charset) throws SQLException

Writes the result set to a file in the CSV format. The result set is read using the following loop:

while (rs.next()) {
    writeRow(row);
}

Parameters

outputFileName:String: the name of the csv file
rs:ResultSet: the result set - the result set must be positioned before the first row.
charset:String: the charset or null to use the system default charset

Returns:int

the number of rows written

Exceptions

SQLException:: on failure

write

back to summary

public int write(Connection conn, String outputFileName, String sql, String charset) throws SQLException

Writes the result set of a query to a file in the CSV format.

Parameters

conn:Connection: the connection
outputFileName:String: the file name
sql:String: the query
charset:String: the charset or null to use the system default charset (see system property file.encoding)

Returns:int

the number of rows written

Exceptions

SQLException:: on failure

writeResultSet	back to summary
private int writeResultSet(ResultSet rs) throws SQLException

writeRow	back to summary
private void writeRow(String[] values) throws IOException

public Class Csv

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail