doc.go

// Copyright (c) 2020 Lukas Aron. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package discogs introduces a way to categorize XML data dumps from Discogs: https://data.discogs.com.
//
// The intention of using this parser is a library, which means there is not an executable part provided.
// The project has no other dependencies than the Golang language itself.
//
// There are three existing writers supported by default: JSON, SQL and DB.
//
// JSON Writer - As the name prompts this writer transforms input XML into JSON format.
// This writer could be used as a solution that converts data into any NoSQL database.
//
// SQL Writer - The second supported writer creates SQL file with all necessary data from input.
// This file can be executed in any SQL database and the result will be populated table with the proper information.
//
// DB Writer - The last writer is for direct communication with the SQL database.
// All input data will be saved into appropriate tables immediately.
// Before using this writer all required data tables need to be created.
// For that purpose please run the SQL script named tables.sql in the sql_scripts folder..
// You can also set up indexes on any column you want,
// to facilitate this process there is also the script called indexes.sql situated in the sql_script folder.
// To speed up a data transformation I would rather recommend creating indexes after the whole processing is completed.
//
// Example of basic usage:
//
//		package main
//
//		import (
//			"fmt"
//			"github.com/lukasaron/data-discogs"
//			"log"
//			"os"
//		)
//
//		func main() {
//			f, err := os.Open("./data_samples/artists.xml")
//			if err != nil {
//				log.Fatal(err)
//			}
//			defer f.Close()
//
//			d := discogs.NewXMLDecoder(f, nil)
//			// decodes 10 artists by default, Block ItemSize can be changed via Options
//			num, artists, err := d.Artists()
//			fmt.Printf("%d, %v, %+v\n", num, err, artists)
//		}
//
// Example with SQL writer
//
//		package main
//
//		import (
//			"fmt"
//			"github.com/lukasaron/data-discogs"
//			"github.com/lukasaron/data-discogs/write"
//			"log"
//			"os"
//		)
//
//		func main() {
//			f, err := os.Open("./data_samples/artists.xml")
//			if err != nil {
//				log.Fatal(err)
//			}
//			defer f.Close()
//
//			d := discogs.NewXMLDecoder(f,
//				&discogs.Options{
//					FileType: discogs.Artists,
//					Block: discogs.Block{
//					ItemSize: 20, // number of items processed at once
//				},
//			})
//
//			o, _ := os.Create("./data_samples/artists.sql")
//			defer o.Close()
//
//			// for instance the SQL writer
//			w := write.NewSQLWriter(o, nil)
//
//			err = d.Decode(w)
//			fmt.Println(err)
//		}
//
package discogs