format

Documentation

Overview

Package format lays out schema SQL without changing the statements it reads. It works on the token stream, so the identifiers, the keywords and the expressions come out exactly as they were written; only the whitespace between the tokens moves. The one exception is a quoted identifier that does not need its quotes, which is unquoted after the change is proved to leave the statement's meaning alone.

Index

• func Format(sql string) (string, error)
• func StripRenamedFrom(sql string) (string, error)

Functions

func Format

func Format(sql string) (string, error)

Format returns sql laid out. It fails when sql does not parse, and when the result would not carry the same tokens as the input.

func StripRenamedFrom

func StripRenamedFrom(sql string) (string, error)

StripRenamedFrom removes every "-- pista:renamed-from" line from sql. Only a comment on a line of its own is a directive, so a comment after code stays, and so does text inside a string or a routine body, which the scanner reads as part of that token.