Guardar archivos CSV en Node

La semana pasada hemos visto el uso del módulo csv-parser para procesar archivos CSV en Node. Lo que facilita la importación de este formato de archivo. Uno de los más utilizados para el intercambio de datos entres sistemas. Esta semana vamos a ver dos módulos (csv-writer y fast-csv) con los que podremos hacer el proceso inverso: guardar archivos CSV en Node.

El módulo csv-writer

Quizás la forma más sencilla para guardar archivos CSV en Node sea ultimar el módulo csv-writer. Módulo que se puede instalar mediante el comando npm en nuestro proyecto, para o que simplemente hay que escribir

npm install fast-csv

Una vez hecho esto en nuestro proyecto se puede importar la función createObjectCsvWriter para crear un objeto que pueda guardar vectores en un archivo CSV. Para lo que a esta función se le debería pasar un objeto con la propiedad path y header. En la propiedad path hay que indicar el archivo en donde se desea guardar los datos. Por otro lado, en la header hay que indicar una lista de objetos que tengan la propiedad id, en la que se indica el nombre por el que se identifica el dato, y la propiedad title, que será el nombre de la columna en el archivo CSV.

Tras crear el objeto se puede llamar al método writeRecords() para se guarden en el archivo un listado de objetos con las propiedades indicadas anteriormente. En el caso de que algún objeto tenga alguna propiedad adicional ésta no se incluirá en el archivo.

Ejemplo de uso de csv-writer

En el siguiente código se puede ver un ejemplo de uso de este módulo. En el que se crea un archivo clientes.csv con columnas para incluir valores de id, nombre, apellidos y edad. Posteriormente se creará un objeto data con los datos que se deseen exportar. Nótese que el nombre de las propiedades en el objeto no es el mismo que el de las columnas en el archivo.

const createObjectCsvWriter = require("csv-writer").createObjectCsvWriter;

const csvWriter = createObjectCsvWriter({
  path: "clients.csv",
  header: [
    {
      id: "id",
      title: "id",
    },
    {
      id: "name",
      title: "first_name",
    },
    {
      id: "surname",
      title: "last_name",
    },
    {
      id: "age",
      title: "age",
    },
  ],
});

const data = [
  {
    id: 1,
    name: "Oralie",
    surname: "Fidgeon",
    age: 30,
  },
  {
    id: 2,
    name: "Imojean",
    surname: "Benet",
    age: 21,
  },
  {
    id: 3,
    name: "Michele",
    surname: "Woodlands",
    age: 27,
  },
  {
    id: 4,
    name: "Ailbert",
    surname: "Risdale",
    age: 22,
  },
  {
    id: 5,
    name: "Stevy",
    surname: "MacGorman",
    age: 24,
  },
];

csvWriter
  .writeRecords(data)
  .then(() => console.log("El archivo se ha guardado"));

Lo que produce el siguiente archivo

id,first_name,last_name,age
1,Oralie,Fidgeon,30
2,Imojean,Benet,21
3,Michele,Woodlands,27
4,Ailbert,Risdale,22
5,Stevy,MacGorman,24

En caso de que sea necesario ejecutar algún código una vez se genere el archivo se puede usar el método then().

Otras opciones de csv-writer

Si necesitamos cambiar el comportamiento de csv-writer se puede incluir algunas opciones en el objeto a la hora de crearlo. Opciones entre las que se puede destacar:

• fieldDelimiter: con el que se puede modificar el separador de valores que por defecto es la coma (,).
• recordDelimiter: mediante la que se indica el salto de línea, cuyo valor por defecto es \n.
• encoding: con la que se indica la codificación usada en el archivo, por defecto el valor es utf8.
• append: mediante este valor boleado se puede indicar si, en caso de que el archivo exista, se agregan los datos o se sobrescriben. Por defecto el valor es false lo que indica que los datos se sobrescribirá.

El módulo fast-csv

Otra alternativa para guardar archivos CSV en Node es utilizar el módulo fast-csv. Un módulo que se puede instalar en nuestro proyecto con el siguiente comando

npm install fast-csv

Un módulo que requiere el uso del módulo fs para guardar los archivos, aunque se encarga del procesado de estos. Así para guardar los mismos datos que antes se puede usar el siguiente código.

const fastcsv = require("fast-csv");
const fs = require("fs");
const file = fs.createWriteStream("fast.csv");

fastcsv.write(data, { headers: true }).pipe(file);

Conclusiones

En esta entrada hemos visto dos módulos disponibles en NPM para guardar archivos CSV en Node. No son los únicos módulos, pero son dos de los más populares y fáciles de utilizar para esta tarea.

Image by Muhammad Umer Idrisi from Pixabay