database

Documentation

Index

• Constants
• func MysqlCliCredentials(credentials DatabaseCredentials) string
• type DatabaseCredentials
• type DatabaseExporter
  • func NewDatabaseExporter(c sftp.Client, p types.PublicPath, u types.SiteUrl, g HttpGetter, ...) DatabaseExporter
• type HttpGetter
• type MysqldumpDatabaseExporter
  • func (e *MysqldumpDatabaseExporter) Export() (io.Reader, error)
• type PHPDatabaseExporter
  • func (e *PHPDatabaseExporter) Export() (io.Reader, error)

Constants

const MYSQLDUMP_PHP_VERSION = "2.11"

Functions

func MysqlCliCredentials

func MysqlCliCredentials(credentials DatabaseCredentials) string

Types

type DatabaseCredentials

type DatabaseCredentials struct {
	User string
	Pass string
	Name string
	Host string
}

type DatabaseExporter

type DatabaseExporter interface {
	Export() (io.Reader, error)
}

func NewDatabaseExporter

func NewDatabaseExporter(c sftp.Client, p types.PublicPath, u types.SiteUrl, g HttpGetter, e emitter.FileEmitter, creds DatabaseCredentials) DatabaseExporter

NewDatabaseExporter is a factory function that returns a DatabaseExporter. It detects at runtime whether the remote server supports `mysqldump` or not, and returns the appropriate exporter.

type HttpGetter

type HttpGetter interface {
	Get(url string) (resp io.ReadCloser, err error)
}

type MysqldumpDatabaseExporter

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

MysqldumpDatabaseExporter is a DatabaseExporter that uses the mysqldump command to export the database. It should be the preferred exporter whenever possible.

func (*MysqldumpDatabaseExporter) Export

func (e *MysqldumpDatabaseExporter) Export() (io.Reader, error)

type PHPDatabaseExporter

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

PHPDatabaseExporter is a DatabaseExporter that uses a custom PHP script to export the database. It should only be used as a fallback when the mysqldump command is not available. The script we utilize is bundled with this package to lock its version and ensure that it is always available. It's source can be found here: https://github.com/ifsnop/mysqldump-php

func (*PHPDatabaseExporter) Export

func (e *PHPDatabaseExporter) Export() (io.Reader, error)

Export We need to upload the PHP script to the server, then run it to generate the database dump.