Documentation
¶
Overview ¶
Package configparser provides a simple parser for reading/writing configuration (INI) files.
Supports reading/writing the INI file format in addition to:
- Reading/writing duplicate section names (ex: MySQL NDB engine's config.ini)
- Options without values (ex: can be used to group a set of hostnames)
- Options without a named section (ex: a simple option=value file)
- Find sections with regexp pattern matching on section names, ex: dc1.east.webservers where regex is '.webservers'
- # or ; as comment delimiter
- = or : as value delimiter
Example ¶
Read and modify a configuration file
package main
import (
"fmt"
"github.com/alyu/configparser"
"log"
)
func main() {
config, err := configparser.Read("/etc/config.ini")
if err != nil {
log.Fatal(err)
}
// Print the full configuration
fmt.Println(config)
// get a section
section, err := config.Section("MYSQLD DEFAULT")
if err != nil {
log.Fatal(err)
} else {
fmt.Printf("TotalSendBufferMemory=%s\n", section.ValueOf("TotalSendBufferMemory"))
// set new value
var oldValue = section.SetValueFor("TotalSendBufferMemory", "256M")
fmt.Printf("TotalSendBufferMemory=%s, old value=%s\n", section.ValueOf("TotalSendBufferMemory"), oldValue)
// delete option
oldValue = section.Delete("DefaultOperationRedoProblemAction")
fmt.Println("Deleted DefaultOperationRedoProblemAction: " + oldValue)
// add new options
section.Add("innodb_buffer_pool_size", "64G")
section.Add("innodb_buffer_pool_instances", "8")
}
// add a new section and options
section = config.NewSection("NDBD MGM")
section.Add("NodeId", "2")
section.Add("HostName", "10.10.10.10")
section.Add("PortNumber", "1186")
section.Add("ArbitrationRank", "1")
// find all sections ending with .webservers
sections, err := config.Find(".webservers$")
if err != nil {
log.Fatal(err)
}
for _, section := range sections {
fmt.Print(section)
}
// or
config.PrintSection("dc1.webservers")
sections, err = config.Delete("NDB_MGMD DEFAULT")
if err != nil {
log.Fatal(err)
}
// deleted sections
for _, section := range sections {
fmt.Print(section)
}
options := section.Options()
fmt.Println(options["HostName"])
// save the new config. the original will be renamed to /etc/config.ini.bak
err = configparser.Save(config, "/etc/config.ini")
if err != nil {
log.Fatal(err)
}
}
Index ¶
- Variables
- func Save(c *Configuration, filePath string) (err error)
- type Configuration
- func (c *Configuration) AllSections() ([]*Section, error)
- func (c *Configuration) Delete(regex string) (sections []*Section, err error)
- func (c *Configuration) FilePath() string
- func (c *Configuration) Find(regex string) ([]*Section, error)
- func (c *Configuration) NewSection(fqn string) *Section
- func (c *Configuration) PrintSection(fqn string)
- func (c *Configuration) Section(fqn string) (*Section, error)
- func (c *Configuration) Sections(fqn string) ([]*Section, error)
- func (c *Configuration) SetFilePath(filePath string)
- func (c *Configuration) String() string
- func (c *Configuration) StringValue(section, option string) (value string, err error)
- type Section
- func (s *Section) Add(option string, value string) (oldValue string)
- func (s *Section) Delete(option string) (value string)
- func (s *Section) Exists(option string) (ok bool)
- func (s *Section) Name() string
- func (s *Section) OptionNames() []string
- func (s *Section) Options() map[string]string
- func (s *Section) SetValueFor(option string, value string) string
- func (s *Section) String() string
- func (s *Section) ValueOf(option string) string
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var Delimiter = "="
Delimiter is the delimiter to be used between section key and values.
Functions ¶
func Save ¶
func Save(c *Configuration, filePath string) (err error)
Save the Configuration to file. Creates a backup (.bak) if file already exists.
Types ¶
type Configuration ¶
type Configuration struct {
// contains filtered or unexported fields
}
Configuration represents a configuration file with its sections and options.
func NewConfiguration ¶
func NewConfiguration() *Configuration
NewConfiguration returns a new Configuration instance with an empty file path.
func Read ¶
func Read(filePath string) (*Configuration, error)
Read parses a specified configuration file and returns a Configuration instance.
func (*Configuration) AllSections ¶
func (c *Configuration) AllSections() ([]*Section, error)
AllSections returns a slice of all sections available.
func (*Configuration) Delete ¶
func (c *Configuration) Delete(regex string) (sections []*Section, err error)
Delete deletes the specified sections matched by a regex name and returns the deleted sections.
func (*Configuration) FilePath ¶
func (c *Configuration) FilePath() string
FilePath returns the configuration file path.
func (*Configuration) Find ¶
func (c *Configuration) Find(regex string) ([]*Section, error)
Find returns a slice of Sections matching the regexp against the section name.
func (*Configuration) NewSection ¶
func (c *Configuration) NewSection(fqn string) *Section
NewSection creates and adds a new Section with the specified name.
func (*Configuration) PrintSection ¶
func (c *Configuration) PrintSection(fqn string)
PrintSection prints a text representation of all sections matching the fully qualified section name.
func (*Configuration) Section ¶
func (c *Configuration) Section(fqn string) (*Section, error)
Section returns the first section matching the fully qualified section name.
func (*Configuration) Sections ¶
func (c *Configuration) Sections(fqn string) ([]*Section, error)
Sections returns a slice of Sections matching the fully qualified section name.
func (*Configuration) SetFilePath ¶
func (c *Configuration) SetFilePath(filePath string)
SetFilePath sets the Configuration file path.
func (*Configuration) String ¶
func (c *Configuration) String() string
String returns the text representation of a parsed configuration file.
func (*Configuration) StringValue ¶
func (c *Configuration) StringValue(section, option string) (value string, err error)
StringValue returns the string value for the specified section and option.
type Section ¶
type Section struct {
// contains filtered or unexported fields
}
A Section in a configuration.
func (*Section) Add ¶
Add adds a new option to the section. Adding and existing option will overwrite the old one. The old value is returned
func (*Section) Delete ¶
Delete removes the specified option from the section and returns the deleted option's value.
func (*Section) OptionNames ¶
OptionNames returns a slice of option names in the same order as they were parsed.
func (*Section) SetValueFor ¶
SetValueFor sets the value for the specified option and returns the old value.