ai.grakn.migration.csv

Class CSVMigrator

java.lang.Object

ai.grakn.migration.base.AbstractMigrator

ai.grakn.migration.csv.CSVMigrator

All Implemented Interfaces:

Migrator, AutoCloseable

public class CSVMigrator
extends AbstractMigrator

The CSV migrator will migrate all of the data in a CSV file into Grakn Graql var patters, to be imported into a graph as the user sees fit.

Author:

alexandraorth

Field Summary

Fields

Modifier and Type	Field and Description
static String	NULL_STRING
static char	QUOTE
static char	SEPARATOR

Fields inherited from class ai.grakn.migration.base.AbstractMigrator

BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
CSVMigrator(String template, File file) Construct a CSVMigrator to migrate data in the given file
CSVMigrator(String template, Reader reader) Construct a CSVMigrator to migrate data in the given Reader

Method Summary

Modifier and Type	Method and Description
void	close() Close the reader
java.util.stream.Stream<InsertQuery>	migrate() Each String in the stream is a CSV file
CSVMigrator	setNullString(String nullString) Set string that will be evaluated as null
CSVMigrator	setQuoteChar(char quote) Set character used to encapsulate values containing special characters.
CSVMigrator	setSeparator(char separator) Set separator the input file will be split on

Methods inherited from class ai.grakn.migration.base.AbstractMigrator

registerMacro, stream, template, validValue

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final char SEPARATOR

See Also:

Constant Field Values

QUOTE

public static final char QUOTE

See Also:

Constant Field Values

NULL_STRING

public static final String NULL_STRING

Constructor Detail

CSVMigrator

public CSVMigrator(String template,
                   File file)

Construct a CSVMigrator to migrate data in the given file

Parameters:

template - parametrized graql insert query

file - file with the data to be migrated

CSVMigrator

public CSVMigrator(String template,
                   Reader reader)

Construct a CSVMigrator to migrate data in the given Reader

Parameters:

template - parametrized graql insert query

reader - reader over the data to be migrated

Method Detail

setSeparator

public CSVMigrator setSeparator(char separator)

Set separator the input file will be split on

Parameters:

separator - character separating columns in input

setQuoteChar

public CSVMigrator setQuoteChar(char quote)

Set character used to encapsulate values containing special characters.

Parameters:

quote - the quote character

setNullString

public CSVMigrator setNullString(String nullString)

Set string that will be evaluated as null

Parameters:

nullString - string that will be evaluated as null, if null, everything will be evaluated as a string

migrate

public java.util.stream.Stream<InsertQuery> migrate()

Each String in the stream is a CSV file

Returns:

stream of parsed insert queries

close

public void close()

Close the reader