protocol

csv_protocol

CSV file and stream reading and writing protocol.

Author: Jacinto Dávila and Paulo Moura
Version: 1:1:0
Date: 2021-09-24
Compilation flags:
static
Dependencies:
(none)
Remarks:
(none)
Inherited public predicates:
(none)

Public predicates

read_file/3

Reads a CSV file saving the data as clauses for the specified object predicate. Fails if the file cannot be parsed.

Compilation flags:
static
Template:
read_file(File,Object,Predicate)
Mode and number of proofs:
read_file(+atom,+object_identifier,+predicate_indicator) - zero_or_one

read_stream/3

Reads a CSV stream saving the data as clauses for the specified object predicate. Fails if the stream cannot be parsed.

Compilation flags:
static
Template:
read_stream(Stream,Object,Predicate)
Mode and number of proofs:
read_stream(+stream_or_alias,+object_identifier,+predicate_indicator) - zero_or_one

read_file/2

Reads a CSV file returning the data as a list of rows, each row a list of fields. Fails if the file cannot be parsed.

Compilation flags:
static
Template:
read_file(File,Rows)
Mode and number of proofs:
read_file(+atom,-list(list)) - zero_or_one

read_stream/2

Reads a CSV stream returning the data as a list of rows, each row a list of fields. Fails if the stream cannot be parsed.

Compilation flags:
static
Template:
read_stream(Stream,Rows)
Mode and number of proofs:
read_stream(+stream_or_alias,-list(list)) - zero_or_one

read_file_by_line/3

Reads a CSV file saving the data as clauses for the specified object predicate. The file is read line by line. Fails if the file cannot be parsed.

Compilation flags:
static
Template:
read_file_by_line(File,Object,Predicate)
Mode and number of proofs:
read_file_by_line(+atom,+object_identifier,+predicate_indicator) - zero_or_one

read_stream_by_line/3

Reads a CSV stream saving the data as clauses for the specified object predicate. The stream is read line by line. Fails if the stream cannot be parsed.

Compilation flags:
static
Template:
read_stream_by_line(Stream,Object,Predicate)
Mode and number of proofs:
read_stream_by_line(+stream_or_alias,+object_identifier,+predicate_indicator) - zero_or_one

read_file_by_line/2

Reads a CSV file returning the data as a list of rows, each row a list of fields. The file is read line by line. Fails if the file cannot be parsed.

Compilation flags:
static
Template:
read_file_by_line(File,Rows)
Mode and number of proofs:
read_file_by_line(+atom,-list(list)) - zero_or_one

read_stream_by_line/2

Reads a CSV stream returning the data as a list of rows, each row a list of fields. The stream is read line by line. Fails if the stream cannot be parsed.

Compilation flags:
static
Template:
read_stream_by_line(Stream,Rows)
Mode and number of proofs:
read_stream_by_line(+stream_or_alias,-list(list)) - zero_or_one

write_file/3

Writes a CSV file with the data represented by the clauses of the specified object predicate.

Compilation flags:
static
Template:
write_file(File,Object,Predicate)
Mode and number of proofs:
write_file(+atom,+object_identifier,+predicate_indicator) - one

write_stream/3

Writes a CSV stream with the data represented by the clauses of the specified object predicate.

Compilation flags:
static
Template:
write_stream(Stream,Object,Predicate)
Mode and number of proofs:
write_stream(+stream_or_alias,+object_identifier,+predicate_indicator) - one

guess_separator/2

Guesses the separator used in a given file, asking the user to confirm.

Compilation flags:
static
Template:
guess_separator(File,Separator)
Mode and number of proofs:
guess_separator(+atom,-atom) - one

guess_arity/2

Guesses the arity of records in a given file, asking the user to confirm.

Compilation flags:
static
Template:
guess_arity(File,Arity)
Mode and number of proofs:
guess_arity(+atom,-number) - one

Protected predicates

(none)

Private predicates

(none)

Operators

(none)