package ppx_csv_conv

  1. Overview
  2. Docs
Generate functions to read/write records in csv format

Install

Dune Dependency

Authors

Maintainers

Sources

ppx_csv_conv-v0.12.0.tar.gz
md5=8372ed5af073cb20b8616d038204f22f

Description

Part of the Jane Street's PPX rewriters collection.

Published: 01 Mar 2019

README

ppx_csv_conv

Generate functions to read/write records in csv format.

ppx_csv_conv generates functions to output some records as a csv file, and read the records back from a list of strings coming from a csv file or a database query.

Usage

Annotate the type: [@@deriving fields, csv]

type t = {
  field : ...
  ....
} [@@deriving fields, csv]

Csv uses fields so fields is also required. Now the functions listed in Csvfields.Csv.Csvable are included in the module, including conversion to and from string lists, dumping to files, and loading files.

The Csvfields.Csv module provides the Atom functor, which accepts a Stringable module to produce the necessary functions for recursive calls:

module Date = struct
  include Date
  include (Csvfields.Csv.Atom (Date) : Csvfields.Csv.Csvable with type t := t)
end

type t = {
  a : float;
  b : string;
  c : int;
  e : Date.t;
} [@@deriving fields, csv]

Generate code/functions with types:

include (Csvfields.Csv.Csvable with type  t :=  t)

(Known) limitations:

  • No option, ref, or lazy_t types allowed.

  • No variant types ... nothing other than primitive types and records. You should create your own stringable version of those types and use the Atom functor.

  • The name of the type must be t.

Dependencies (7)

  1. ppxlib >= "0.5.0" & < "0.9.0"
  2. dune >= "1.5.1"
  3. ppx_fields_conv >= "v0.12" & < "v0.13"
  4. ppx_conv_func >= "v0.12" & < "v0.13"
  5. csvfields >= "v0.12" & < "v0.13"
  6. base >= "v0.12" & < "v0.13"
  7. ocaml >= "4.07.0"

Dev Dependencies

None

Used by (2)

  1. biotk
  2. gemini >= "0.2.0"

Conflicts

None

OCaml

Innovation. Community. Security.