Hledger.Query

A general query system for matching things (accounts, postings, transactions..) by various criteria, and a parser for query expressions.

Query and QueryOpt

data Query

A query is a composition of search criteria, which can be used to match postings, transactions, accounts and more.

Constructors

Any

always match

None

never match

Not Query

negate this match

Or [Query]

match if any of these match

And [Query]

match if all of these match

Code String

match if code matches this regexp

Desc String

match if description matches this regexp

Acct String

match postings whose account matches this regexp

Date DateSpan

match if primary date in this date span

Date2 DateSpan

match if secondary date in this date span

Status Bool

match if cleared status has this value

Real Bool

match if realness (involves a real non-virtual account ?) has this value

Amt Ordering Quantity

match if the amount's numeric quantity is less thangreater thanequal to some value

Empty Bool

if true, show zero-amount postings/accounts which are usually not shown more of a query option than a query criteria ?

Depth Int

match if account depth is less than or equal to this value

Tag String (Maybe String)

match if a tag with this exact name, and with value matching the regexp if provided, exists

Instances

Eq Query

Show Query

data QueryOpt

A query option changes a query's/report's behaviour and output in some way.

Constructors

QueryOptInAcctOnly AccountName

show an account register focussed on this account

QueryOptInAcct AccountName

as above but include sub-accounts in the account register | QueryOptCostBasis -- ^ show amounts converted to cost where possible | QueryOptDate2 -- ^ show secondary dates instead of primary dates

Instances

Eq QueryOpt

Show QueryOpt

parsing

parseQuery :: Day -> String -> (Query, [QueryOpt])

Convert a query expression containing zero or more space-separated terms to a query and zero or more query options. A query term is either:

1. a search pattern, which matches on one or more fields, eg:

acct:REGEXP - match the account name with a regular expression desc:REGEXP - match the transaction description date:PERIODEXP - match the date with a period expression

The prefix indicates the field to match, or if there is no prefix account name is assumed.

1. a query option, which modifies the reporting behaviour in some way. There is currently one of these, which may appear only once:

inacct:FULLACCTNAME

The usual shell quoting rules are assumed. When a pattern contains whitespace, it (or the whole term including prefix) should be enclosed in single or double quotes.

Period expressions may contain relative dates, so a reference date is required to fully parse these.

Multiple terms are combined as follows: 1. multiple account patterns are OR'd together 2. multiple description patterns are OR'd together 3. then all terms are AND'd together

simplifyQuery :: Query -> Query

filterQuery :: (Query -> Bool) -> Query -> Query

Remove query terms (or whole sub-expressions) not matching the given predicate from this query. XXX Semantics not yet clear.

accessors

queryIsNull :: Query -> Bool

Does this query match everything ?

queryIsDepth :: Query -> Bool

queryIsDate :: Query -> Bool

queryIsStartDateOnly :: Bool -> Query -> Bool

Does this query specify a start date and nothing else (that would filter postings prior to the date) ? When the flag is true, look for a starting secondary date instead.

queryStartDate :: Bool -> Query -> Maybe Day

What start date (or secondary date) does this query specify, if any ? For OR expressions, use the earliest of the dates. NOT is ignored.

queryDateSpan :: Bool -> Query -> DateSpan

What date span (or secondary date span) does this query specify ? For OR expressions, use the widest possible span. NOT is ignored.

queryDepth :: Query -> Int

The depth limit this query specifies, or a large number if none.

queryEmpty :: Query -> Bool

The empty (zero amount) status specified by this query, defaulting to false.

inAccount :: [QueryOpt] -> Maybe (AccountName, Bool)

The account we are currently focussed on, if any, and whether subaccounts are included. Just looks at the first query option.

inAccountQuery :: [QueryOpt] -> Maybe Query

A query for the account(s) we are currently focussed on, if any. Just looks at the first query option.

matching

matchesAccount :: Query -> AccountName -> Bool

Does the match expression match this account ? A matching in: clause is also considered a match.

matchesPosting :: Query -> Posting -> Bool

Does the match expression match this posting ?

matchesTransaction :: Query -> Transaction -> Bool

Does the match expression match this transaction ?

tests

tests_Hledger_Query :: Test