org.fastnate.generator.statements

Class PostgreSqlBulkWriter

java.lang.Object

org.fastnate.generator.statements.AbstractStatementsWriter

org.fastnate.generator.statements.FileStatementsWriter

org.fastnate.generator.statements.PostgreSqlBulkWriter

All Implemented Interfaces:

Closeable, AutoCloseable, StatementsWriter

public class PostgreSqlBulkWriter
extends FileStatementsWriter

Implementation of a StatementsWriter that writes bulk text files for each table, and references them in "COPY INTO".

Author:

Tobias Liefke

Nested Class Summary

Nested classes/interfaces inherited from class org.fastnate.generator.statements.AbstractStatementsWriter

AbstractStatementsWriter.AbstractTableStatement, AbstractStatementsWriter.InsertStatement, AbstractStatementsWriter.PlainStatement, AbstractStatementsWriter.UpdateStatement

Field Summary

Fields inherited from class org.fastnate.generator.statements.FileStatementsWriter

OUTPUT_ENCODING_KEY, OUTPUT_FILE_KEY

Constructor Summary

Constructors

Constructor and Description
PostgreSqlBulkWriter(GeneratorContext context) Creates a new instance for a SQL file with UTF-8 encoding.
PostgreSqlBulkWriter(GeneratorContext context, File sqlFile) Creates a new instance for a SQL file with UTF-8 encoding.
PostgreSqlBulkWriter(GeneratorContext context, File sqlFile, Charset encoding) Creates a new instance for a SQL file.
PostgreSqlBulkWriter(GeneratorContext context, File directory, Writer writer, Charset encoding) Creates a new instance of PostgreSqlBulkWriter.

Method Summary

Modifier and Type	Method and Description
void	close()
void	closeBulkWriter(GeneratorTable table) Closes the current writer of the given table (for example when the table structure has changed).
void	flush() Flushes any open statements.
File	getDirectory() The directory for the bulk files.
Charset	getEncoding() The encoding of the bulk files.
List<File>	getGeneratedFiles() All files generated by this writer.
int	getStatementsCount() The count of written statements.
void	writePlainStatement(GeneratorDialect dialect, String sql) Writes a plain SQL statement.
void	writeStatement(EntityStatement stmt) Writes the given statement to a file or database.

Methods inherited from class org.fastnate.generator.statements.FileStatementsWriter

ensureDirectoryExists, getStatementSeparator, getWriter, setStatementSeparator, write, writeComment, writeSectionSeparator

Methods inherited from class org.fastnate.generator.statements.AbstractStatementsWriter

createInsertStatement, createPlainStatement, createUpdateStatement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fastnate.generator.statements.StatementsWriter

truncateTables

Constructor Detail

PostgreSqlBulkWriter

public PostgreSqlBulkWriter(GeneratorContext context)
                     throws FileNotFoundException

Creates a new instance for a SQL file with UTF-8 encoding. All bulk files will end up in the same directory as the given file.

Parameters:

context - the current generation context

Throws:

FileNotFoundException - if the directory is not available

PostgreSqlBulkWriter

public PostgreSqlBulkWriter(GeneratorContext context,
                            File sqlFile)
                     throws FileNotFoundException

Creates a new instance for a SQL file with UTF-8 encoding. All bulk files will end up in the same directory as the given file.

Parameters:

context - the current generation context

sqlFile - the file that is feeded with all plain statements

Throws:

FileNotFoundException - if the directory is not available

PostgreSqlBulkWriter

public PostgreSqlBulkWriter(GeneratorContext context,
                            File sqlFile,
                            Charset encoding)
                     throws FileNotFoundException

Creates a new instance for a SQL file. All bulk files will end up in the same directory as the given file.

Parameters:

context - the current generation context

sqlFile - the file that is feeded with all plain statements

encoding - the encoding of all written files

Throws:

FileNotFoundException - if the directory is not available

PostgreSqlBulkWriter

public PostgreSqlBulkWriter(GeneratorContext context,
                            File directory,
                            Writer writer,
                            Charset encoding)

Creates a new instance of PostgreSqlBulkWriter.

Parameters:

context - the current generation context

directory - the directory for the bulk files

writer - the SQL file which contains the plain and the "COPY" statements

encoding - The encoding of the bulk files.

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FileStatementsWriter

Throws:

IOException

closeBulkWriter

public void closeBulkWriter(GeneratorTable table)
                     throws IOException

Closes the current writer of the given table (for example when the table structure has changed).

Parameters:

table - the table of the writer

Throws:

IOException - if there was a problem when closing the writer

flush

public void flush()
           throws IOException

Description copied from interface: StatementsWriter

Flushes any open statements.

Specified by:

flush in interface StatementsWriter

Overrides:

flush in class FileStatementsWriter

Throws:

IOException - if the target throws an exception

writePlainStatement

public void writePlainStatement(GeneratorDialect dialect,
                                String sql)
                         throws IOException

Description copied from interface: StatementsWriter

Writes a plain SQL statement. Shortcut for writeStatement(createPlainStatement(sql), dialect).

Specified by:

writePlainStatement in interface StatementsWriter

Overrides:

writePlainStatement in class FileStatementsWriter

Parameters:

dialect - the current database dialect

sql - the content of the SQL statement

Throws:

IOException - if the file or database throws an exception

writeStatement

public void writeStatement(EntityStatement stmt)
                    throws IOException

Description copied from interface: StatementsWriter

Writes the given statement to a file or database.

Specified by:

writeStatement in interface StatementsWriter

Overrides:

writeStatement in class FileStatementsWriter

Parameters:

stmt - contains the values to write

Throws:

IOException - if the file or database throws an exception

getDirectory

@Generated(value="lombok")
public File getDirectory()

The directory for the bulk files.

getEncoding

@Generated(value="lombok")
public Charset getEncoding()

The encoding of the bulk files.

getGeneratedFiles

@Generated(value="lombok")
public List<File> getGeneratedFiles()

All files generated by this writer.

getStatementsCount

@Generated(value="lombok")
public int getStatementsCount()

The count of written statements.

Overrides:

getStatementsCount in class FileStatementsWriter