Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
sqitch-log(3)	      User Contributed Perl Documentation	 sqitch-log(3)

Name
       sqitch-log - Show Sqitch	change logs

Synopsis
	 sqitch	[options] log [<options>] [<database>]

Description
       Sqitch keeps a record of	the deployment,	failed deployment, or
       reversion of all	changes	in a target database. Even after a change has
       been reverted, a	log of its earlier deployment is retained. The "log"
       command is your key to accessing	it. You	can simply list	all the
       events, search for events matching regular expressions, and limit the
       results.

       The "<database>"	parameter specifies the	database to which to connect,
       and may also be specified as the	"--target" option. It can be target
       name, a URI, an engine name, or plan file path.

Options
       "-t"
       "--target"
	   The target database to which	to connect. This option	can be either
	   a URI or the	name of	a target in the	configuration.

       "--event"
	   Filter by event type. May be	specified more than once. Allowed
	   values are:

	   o   "deploy"

	   o   "revert"

	   o   "fail"

       "--change-pattern"
       "--change"
	   A regular expression	to match against change	names.

       "--project-pattern"
       "--project"
	   A regular expression	to match against project names.

       "--committer-pattern"
       "--committer"
	   A regular expression	to match against committer names.

       "--format"
       "-f"
	   The format to use. May be one of:

	   "full"
	   "long"
	   "medium"
	   "short"
	   "oneline"
	   "raw"
	   "format:<string>"

	   See "Formats" for details on	each format. Defaults to "medium".

       "--date-format"
       "--date"
	   Format to use for timestamps. Defaults to "iso". Allowed values:

	   "iso"
	   "iso8601"
	       Shows timestamps	in ISO-8601 format.

	   "rfc"
	   "rfc2822"
	       Show timestamps in RFC-2822 format.

	   "full"
	   "long"
	   "medium"
	   "short"
	       Show timestamps in the specified	format length, using the
	       system locale's "LC_TIME" category.

	   "raw"
	       Show timestamps in raw format, which is strict ISO-8601 in the
	       UTC time	zone.

	   "strftime:$string"
	       Show timestamps using an	arbitrary "strftime" pattern. See
	       "strftime Paterns" in DateTime for comprehensive	documentation
	       of supported patterns.

	   "cldr:$pattern"
	       Show timestamps using an	arbitrary "cldr" pattern. See "CLDR
	       Paterns"	in DateTime for	comprehensive documentation of
	       supported patterns.

       "--max-count"
       "-n"
	   Limit the number of events to output.

       "--skip"
	   Skip	the specified number events before starting to show the	event
	   output.

       "--reverse"
	   Output the events in	reverse	order.

       "--no-reverse"
	   Do not output the events in reverse order.

       "--color"
	   Show	colored	output.	The value may be one of:

	   "auto" (the default)
	   "always"
	   "never"
       "--no-color"
	   Turn	off colored output. It is the same as "--color never".

       "--abbrev"
	   Instead of showing the full 40-byte hexadecimal change ID, show
	   only	a partial prefix the specified number of characters long.

       "--oneline"
	   Shorthand for "--format oneline --abbrev 6".

Configuration Variables
       "log.format"
	   Output format to use. Supports the same values as "--format".

       "log.date_format"
	   Format to use for timestamps. Supports the same values as the
	   "--date-format" option.

       "log.color"
	   Output colors. Supports the same values as the "--color" option.

Formats
       There are several built-in formats, and you can emit data in a custom
       format "format:<string>"	format.	Here are the details of	the built-in
       formats:

       "oneline"
	     <change id> <event	type> <project name>:<change name> <title line>

	   This	is designed to be as compact as	possible.

       "short"
	     <event type> <change id>
	     Name:	<change	name>
	     Committer:	<committer>

	     <title line>

       "medium"
	     <event type> <change id>
	     Name:	<change	name>
	     Committer:	<committer>
	     Date:	<commit	date>

	     <full change note>

       "long"
	     <event type> <change id> <tags>
	     Name:	<change	name>
	     Project:	<change	name>
	     Planner:	<planner>
	     Committer:	<committer>

	     <full change note>

       "full"
	     <event type> <change id> <tags>
	     Event:	<event type>
	     Name:	<change	name>
	     Project:	<change	name>
	     Requires:	<required changes>
	     Conflicts:	<conflicting changes>
	     Planner:	<planner>
	     Planned:	<plan date>
	     Committer:	<committer>
	     Committed:	<commit	date>

	     <full change note>

       "raw"
	     <event type> <change id> <tags>
	     name      <change name>
	     project   <project	name>
	     requires  <required changes>
	     conflicts <conflicting changes>
	     planner   <planner>
	     planned   <raw plan date>
	     committer <committer>
	     committed <raw commit date>

	     <full change note>

	   Suitable for	parsing: the change ID is displayed in full, without
	   regard to the value of "--abbrev"; dates are	formatted raw (strict
	   ISO-8601 format in the UTC time zone); and all labels are
	   lowercased and unlocalized.

       "format:<string>"
	   The "format:<string>" format	allows you to specify which
	   information you want	to show. It works a little bit like "printf"
	   format and a	little like Git	log format. For	example, this format:

	     format:The	committer of %h	was %{name}c%vThe title	was >>%s<<%v

	   Would show something	like this:

	     The committer of f26a3s was Tom Lane
	     The title was >>We	really need to get this	right.<<

	   The placeholders are:

	   o   %H: Event change	ID

	   o   %h: Event change	ID (respects "--abbrev")

	   o   %n: Event change	name

	   o   %o: Event change	project	name

	   o   "%($len)h": abbreviated change of length	$len

	   o   %e: Event type (deploy, revert, fail)

	   o   %l: Localized lowercase event type label

	   o   %L: Localized title case	event type label

	   o   %c: Event committer name	and email address

	   o   "%{name}c": Event committer name

	   o   "%{email}c": Event committer email address

	   o   "%{date}c": commit date (respects "--date-format")

	   o   "%{date:rfc}c": commit date, RFC2822 format

	   o   "%{date:iso}c": commit date, ISO-8601 format

	   o   "%{date:full}c":	commit date, full format

	   o   "%{date:long}c":	commit date, long format

	   o   "%{date:medium}c": commit date, medium format

	   o   "%{date:short}c": commit	date, short format

	   o   "%{date:cldr:$pattern}c": commit	date, formatted	with custom
	       CLDR pattern

	   o   "%{date:strftime:$pattern}c": commit date, formatted with
	       custom strftime pattern

	   o   %c: Change planner name and email address

	   o   "%{name}p": Change planner name

	   o   "%{email}p": Change planner email address

	   o   "%{date}p": plan	date (respects "--date-format")

	   o   "%{date:rfc}p": plan date, RFC2822 format

	   o   "%{date:iso}p": plan date, ISO-8601 format

	   o   "%{date:full}p":	plan date, full	format

	   o   "%{date:long}p":	plan date, long	format

	   o   "%{date:medium}p": plan date, medium format

	   o   "%{date:short}p": plan date, short format

	   o   "%{date:cldr:$pattern}p": plan date, formatted with custom CLDR
	       pattern

	   o   "%{date:strftime:$pattern}p": plan date,	formatted with custom
	       strftime	pattern

	   o   %t: Comma-delimited list	of tags

	   o   "%{$sep}t": list	of tags	delimited by $sep

	   o   %T: Parenthesized list of comma-delimited tags

	   o   "%{$sep}T": Parenthesized list of tags delimited	by $sep

	   o   %s: Subject (a.k.a. title line)

	   o   %r: Comma-delimited list	of required changes

	   o   "%{$sep}r": list	of required changes delimited by $sep

	   o   %R: Localized label and list of comma-delimited required
	       changes

	   o   "%{$sep}R": Localized label and list of required	changes
	       delimited by $sep

	   o   %x: Comma-delimited list	of conflicting changes

	   o   "%{$sep}x": list	of conflicting changes delimited by $sep

	   o   %X: Localized label and list of comma-delimited conflicting
	       changes

	   o   "%{$sep}X": Localized label and list of conflicting changes
	       delimited by $sep

	   o   %b: Body

	   o   %B: Raw body (unwrapped subject and body)

	   o   "%{$prefix}"B: Raw body with $prefix prefixed to	every line

	   o   "%{event}_" Localized label for "event"

	   o   "%{change}_" Localized label for	"change"

	   o   "%{committer}_" Localized label for "committer"

	   o   "%{planner}_" Localized label for "planner"

	   o   "%{by}_"	Localized label	for "by"

	   o   "%{date}_" Localized label for "date"

	   o   "%{committed}_" Localized label for "committed"

	   o   "%{planned}_" Localized label for "planned"

	   o   "%{name}_" Localized label for "name"

	   o   "%{project}_" Localized label for "project"

	   o   "%{email}_" Localized label for "email"

	   o   "%{requires}_" Localized	label for "requires"

	   o   "%{conflicts}_" Localized label for "conflicts"

	   o   %v vertical space (newline)

	   o   "%{$color}C": An	ANSI color: black, red,	green, yellow, reset,
	       etc.

	   o   "%{:event}C": An	ANSI color based on event type (green deploy,
	       blue revert, red	fail)

	   o   "%{$attribute}a": The raw attribute name	and value, if it
	       exists and has a	value

Sqitch
       Part of the sqitch suite.

perl v5.24.1			  2017-07-03			 sqitch-log(3)

Name | Synopsis | Description | Options | Configuration Variables | Formats | Sqitch

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=sqitch-log&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help