csvalidator

README

CSValidator

CSValidator is a tool for validation of .csv files using JSON schema

Quick Start

Install

go get -u github.com/markelrep/csvalidator

Schema

{
  "columns":[
    {
      "name": "id",
      "required": true
    },
    {
      "name": "comment",
      "required": false
    }
  ]
}

columns is array of objects with validation rules for each columns in .csv file

name of column, which should be the same as in .csv file otherwise validation will be failed. This field also supports regexp. Example

required true means that this column is required to exist in file, false that isn't required

Usage

package main
import "github.com/markelrep/csvalidator"

func main() {
	validator, err := csvalidator.NewValidator(csvalidator.Config{
		FilePath:       "./path/to/csv/files",
		FirstIsHeader:  true,
		SchemaPath:     "./path/to/json/schema",
		WorkerPoolSize: 0,
		// If ErrFilePath is defined then all errors with be written to this file else to the std our 
		ErrFilePath "./path/to/dst/file/with/errors"
	})
	if err != nil {
		// handle error
    }
	if err := validator.Validate(); err != nil {
		// handle error
	}
}

Documentation

Index

• type Validator
  • func NewValidator(config config.Config) (Validator, error)
  • func (v *Validator) Validate() error

Types

type Validator

type Validator struct {
	// contains filtered or unexported fields
}

Validator stores csv files which to be validated and validate rules

func NewValidator

func NewValidator(config config.Config) (Validator, error)

NewValidator creates a new Validator

func (*Validator) Validate

func (v *Validator) Validate() error

Validate checks files and expose errors. each file check runs concurrently errors return after all files are validated