Changes between Version 1 and Version 2 of TracReports


Ignore:
Timestamp:
Sep 2, 2019, 4:56:56 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracReports

    v1 v2  
    1 ** Note: このページは、Tracのバージョン1.0を文書化しています、旧バージョンが必要であれば、[[0.12/TracReports]]を参照してください **
    2 = レポート = #TracReports
     1= Trac Reports
     2
    33[[TracGuideToc]]
    44
    5 レポートモジュールは、簡単かつ強力なレポーティング機能を提供します。
    6 この機能によって、 Trac データベースのチケット情報を取得することができます。
    7 
    8 TracReports ではレポートの形式を定義するための方法として、独自フォーマットではなく、
    9 SQL の `SELECT` 文を使用することにしました。
    10 
    11   '''Note:''' ''現在の形式のレポートモジュールは、 Trac 開発チームでデータベースのスキーマにあわせる作業が必要になるという深刻な制限事項があるため、段階的に廃止します。より柔軟性に富みユーザビリティに優れた [wiki:TracQuery クエリモジュール] が代替手段として提供されます。どこかの時点でレポートモジュールを完全に削除することが出来るように、クエリモジュールで実現できないレポートがある間は、私たちはクエリモジュールを強化していくつもりです。また、これはレポートモジュールへの重要な機能追加は行わないことを意味します。''
    12 
    13   ''以下の [wiki:TracIni trac.ini] のように無効化するだけで、レポートモジュールをクエリモジュールで完全に置き換えることができます:''
    14   {{{
     5The Trac reports module provides a simple, yet powerful reporting facility to present information about tickets in the Trac database.
     6
     7Rather than have its own report definition format, TracReports relies on standard SQL `SELECT` statements for custom report definition.
     8
     9  '''Note:''' The report module is being phased out in its current form because it seriously limits the ability of the Trac team to make adjustments to the underlying database schema. We believe that the [wiki:TracQuery query module] is a good replacement that provides more flexibility and better usability. While there are certain reports that cannot yet be handled by the query module, we intend to further enhance it so that at some point the reports module can be completely removed. This also means that there will be no major enhancements to the report module anymore.
     10
     11  You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:
     12  {{{#!ini
    1513  [components]
    1614  trac.ticket.report.* = disabled
    1715  }}}
    18   ''これによって、ナビゲーションバーの "チケットを見る" (英語版では "View Tickets") でのデフォルトのハンドラがクエリモジュールになります。もし可能ならば、この設定を有効にして、レポート機能がなくなることによって生じる不都合を報告してください。''
    19 
    20 レポートは以下の基本的なパーツから構成されます:
    21  * '''ID''' — ユニークな (連番の) 識別子
    22  * '''レポート名 (Title)''' — レポートのタイトル
    23  * '''説明 (Description)''' — WikiFormatting で記述された、レポートの説明
    24  * '''レポート本体 (Report Body)''' — 後に述べるフォーマットで規定された、レポートクエリの結果
    25  * '''フッタ (Footer)''' — レポート本体を異なる形式でダウンロードするためのリンク
    26 
    27 == ソートの並び順変更 == #ChangingSortOrder
    28 単純なレポート (特にグループ化されていないもの) では、カラムのヘッダをクリックすれば、そのカラムでソートすることが出来ます。
    29 
    30 カラムのヘッダがハイパーリンク (赤) になっていれば、クリックすることでそのカラムでのソートができます。並び順を逆にするには、もう一度クリックします。
    31 
    32 == レポートの番号を変更する == #ChangingReportNumbering
    33 レポートの ID を変更する必要がある場合があるかもしれませんが、おそらくレポート自体を編集する方がベターです。というのも Trac のデータベースを変更する必要があるからです。 ''report'' 表は以下のようなスキーマとなっています ''(0.10 以降)'':
     16  This will make the query module the default handler for the “View Tickets” navigation item. We encourage you to try this configuration and report back what kind of features of reports you are missing, if any.
     17
     18A report consists of these basic parts:
     19 * '''ID''' — Unique (sequential) identifier
     20 * '''Title''' — Descriptive title
     21 * '''Description''' — A brief description of the report, in WikiFormatting text.
     22 * '''Report Body''' — List of results from report query, formatted according to the methods described below.
     23 * '''Footer''' — Links to alternative download formats for this report.
     24
     25== Changing Sort Order
     26
     27Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header.
     28
     29If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.
     30
     31== Changing Report Numbering
     32
     33There may be instances where you need to change the ID of the report, perhaps to organize the reports better. At present this requires changes to the trac database. The ''report'' table has the following schema:
    3434 * id integer PRIMARY KEY
    3535 * author text
    … …  
    3737 * query text
    3838 * description text
    39 ID を変更すると ''レポート一覧 (Available Reports)'' での表示順と番号、レポートのパーマリンクが変更されます。以下のような SQL を実行すると ID が変更されます:
    40 {{{
    41 update report set id=5 where id=3;
    42 }}}
    43 メンテナンス結果、データベースの一貫性を保つ必要があることに留意してください (例えば ID はユニークでなければなりませんし、 SQLite などデータベースの上限値を超えることはできません)。
    44 
    45 保存されたレポートやクエリのレポート番号も更新したり削除したりする必要があるでしょう。
    46 
    47 == チケットをナビゲート == #NavigatingTickets
    48 レポートクエリ結果の 1 チケットをクリックするとそのチケットが表示されるでしょう。表示されたチケットのメインメニューバーのすぐ下にある ''次のチケット'' (英語版では ''Next Ticket'') または ''前のチケット'' (英語版では ''Previous Ticket'') リンクをクリックすることによって他のチケットに移動するか、''レポートに戻る'' (英語版では ''Back to Report'') リンクをクリックしてレポートページに戻ることができます。
    49 
    50 あなたは安全にチケットを編集することができます。またチケットの編集結果を保存した後で、 ''次のチケット/前のチケット/レポートに戻る'' (英語版では ''!Next/Previous/Back to Report'') のリンクを使用して結果を行き来することが可能です。しかし、あなたがチケットへの操作を終えてレポートに戻るときに、どのチケットが変更されたかのヒントは表示されません。この動作はカスタムクエリの動作とは異なります。 (カスタムクエリについては TracQuery#NavigatingTickets を参照して下さい) 。 ''(0.11 以降 )''
    51 
    52 == ダウンロードできるフォーマット == #AlternativeDownloadFormats
    53 通常表示される HTML でのビューの加え、レポートはいろいろな形式で使用することができます。
    54 レポートページの一番下に、利用可能なデータ形式の一覧があります。望む形式のリンクをクリックすれば、
    55 その形式でのレポートをダウンロードすることができます。
    56 
    57 === カンマ区切りテキスト - CSV (Comma Separated Values) === #Comma-delimited-CSVCommaSeparatedValues
    58 1 レコードを 1 行として、各カラムをカンマ (',') で区切ったプレーンテキストとしてダウンロードできます。
    59 '''Note:''' 各カラムのデータに改行文字やカンマがある場合、エスケープされて出力されます。
    60 
    61 === タブ区切り === #Tab-delimited
    62 CSV と似ていますが、水平タブ文字 (\t) で区切られる点が違います。
    63 
    64 === RSS - XML コンテンツ配信 === #RSS-XMLContentSyndication
    65 全てのレポートは、 XML/RSS 2.0 での配信が可能です。 RSS フィードを購読するにはページ下部にある、オレンジ色の 'XML' アイコンをクリックしてください。 Trac での RSS 対応についての一般的な情報は、 TracRss に記述しています。
    66 
    67 ----
    68 
    69 == カスタムレポートを作成する == #CreatingCustomReports
    70 
    71 ''カスタムレポートを作成するためには、 SQL を楽に書ける程度の知識が必要です。''
    72 
    73 '''Note: レポートの追加、編集ボタンを表示させるためには [TracPermissions#Reports permissions] をセットアップする必要があります。'''
    74 
    75 レポートは基本的に、 Trac が実行できる形式の、名前がついた特定 SQL です。
    76 レポートに指定された SQL は、直接 Web インタフェースから閲覧したり、
    77 作成したりできます。
    78 
    79 通常のレポートは、 'ticket' 表に対する、カラムの選択や、ソート指定を伴った
    80 SELECT 文となります。
    81 
    82 == Ticket 表のカラム == #Ticketcolumns
    83 ''ticket'' 表は、以下のカラムを持ちます:
    84  * id           -- チケットID
    85  * type         -- チケット分類
    86  * time         -- 登録日時
    87  * changetime   -- 最終更新日時
    88  * component    -- コンポーネント
    89  * severity     -- 重要度
    90  * priority     -- 優先度
    91  * owner        -- 担当者
    92  * reporter     -- 報告者
    93  * cc           -- 関係者
    94  * version      -- バージョン
    95  * milestone    -- マイルストーン
    96  * status       -- ステータス
    97  * resolution   -- 解決方法
    98  * summary      -- チケットの概要
    99  * description  -- チケットについての完全な説明
    100  * keywords     -- キーワード
    101 
    102 各カラムに対応する属性の詳細な説明は、 TracTickets に記述しています。
    103 
    104 例: '''優先度順、登録日時順の全未解決チケット'''
    105 {{{
    106 SELECT id AS ticket, status, severity, priority, owner,
    107        time AS created, summary FROM ticket
    108   WHERE status IN ('new', 'assigned', 'reopened')
    109   ORDER BY priority, time
    110 }}}
    111 
    112 
    113 == 上級トピック: 動的変数の使用 == #AdvancedReports:DynamicVariables
    114 レポートに汎用性を持たせる手段として、 ''動的変数'' をレポート SQL で使用する方法があります。
    115 簡単に言うと、動的変数とは、クエリを実行する前に置き換えられる ''特別な'' 文字列のことです。
    116 
    117 === クエリで動的変数を使う方法 === #UsingVariablesinaQuery
    118 動的変数を使うためのシンタックスは単純です。 '$' に続いて、大文字で変数名となる語を挿入してください。
    119 
    120 例:
    121 {{{
     39Changing the ID changes the shown order and number in the ''Available Reports'' list and the report's perma-link. This is done by running something like:
     40{{{#!sql
     41UPDATE report SET id = 5 WHERE id = 3;
     42}}}
     43Keep in mind that the integrity has to be maintained, ie ID has to be unique, and you don't want to exceed the max, since that's managed by SQLite someplace.
     44
     45You may also need to update or remove the report number stored in the report or query.
     46
     47== Navigating Tickets
     48
     49Clicking on one of the report results will take you to that ticket. You can navigate through the results by clicking the ''Next Ticket'' or ''Previous Ticket'' links just below the main menu bar, or click the ''Back to Report'' link to return to the report page.
     50
     51You can safely edit any of the tickets and continue to navigate through the results using the ''!Next/Previous/Back to Report'' links after saving your results, but when you return to the report, there will be no hint about what has changed, as would happen if you were navigating a list of tickets obtained from a query (see TracQuery#NavigatingTickets).
     52
     53== Alternative Download Formats
     54
     55Aside from the default HTML view, reports can also be exported in a number of alternative formats.
     56At the bottom of the report page, you will find a list of available data formats. Click the desired link to
     57download the alternative report format.
     58
     59=== Comma-delimited - CSV (Comma Separated Values)
     60
     61Export the report as plain text, each row on its own line, columns separated by a single comma (',').
     62'''Note:''' The output is fully escaped so carriage returns, line feeds, and commas will be preserved in the output.
     63
     64=== Tab-delimited
     65
     66Like above, but uses tabs (\t) instead of comma.
     67
     68=== RSS - XML Content Syndication
     69
     70All reports support syndication using XML/RSS 2.0. To subscribe to an RSS feed, click the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac.
     71
     72== Creating Custom Reports
     73
     74Creating a custom report requires a comfortable knowledge of SQL.
     75
     76Note that you need to set up [TracPermissions#Reports permissions] in order to see the buttons for adding or editing reports.
     77
     78A report is basically a single named SQL query, executed and presented by Trac. Reports can be viewed and created from a custom SQL expression directly in the web interface.
     79
     80Typically, a report consists of a SELECT-expression from the 'ticket' table, using the available columns and sorting the way you want it.
     81
     82== Ticket columns
     83
     84The ''ticket'' table has the following columns:
     85 * id
     86 * type
     87 * time
     88 * changetime
     89 * component
     90 * severity 
     91 * priority
     92 * owner
     93 * reporter
     94 * cc
     95 * version
     96 * milestone
     97 * status
     98 * resolution
     99 * summary
     100 * description
     101 * keywords
     102
     103See TracTickets for a detailed description of the column fields.
     104
     105Example: '''All active tickets, sorted by priority and time'''
     106{{{#!sql
     107SELECT id AS ticket, status, severity, priority, owner, time AS created, summary
     108FROM ticket
     109WHERE status IN ('new', 'assigned', 'reopened')
     110ORDER BY priority, time
     111}}}
     112
     113Dynamic variables can also be used in the report title and description (since 1.1.1).
     114
     115== Advanced Reports: Dynamic Variables
     116
     117For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements.
     118In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution. Dynamic variables are entered through the preferences form and the values are autocompleted //(Since 1.3.2)//.
     119
     120=== Using Variables in a Query
     121
     122The syntax for dynamic variables is simple, any upper case word beginning with `$` is considered a variable.
     123
     124Example:
     125{{{#!sql
    122126SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
    123127}}}
    124128
    125 レポート閲覧時、 $PRIORITY に値を当てはめるためには、レポートの URL に引数として変数を与えてください。この変数名に '$' を入れてはいけません。
    126 
    127 例:
     129The value of the dynamic variable can be assigned in the report preferences form.
     130
     131To assign a value to `$PRIORITY` in the URL for a report, leave out the leading `$`:
    128132{{{
    129133 http://trac.edgewall.org/reports/14?PRIORITY=high
    130134}}}
    131135
    132 複数の値を使用する場合、各値を '&' で区切ります。
    133 
    134 例:
     136To use multiple variables, separate them with an `&`:
    135137{{{
    136138 http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
    137139}}}
    138140
    139 
    140 === 特殊な定数 === #SpecialConstantVariables
    141 実用的なレポートにするために、自動的に値が設定される動的変数が用意されています。(URL で指定されると上書かれます)
    142 
    143  * $USER -- ログインに使用したユーザ名
    144 
    145 例 (''私が担当になっているチケット一覧''):
    146 {{{
     141It is possible to assign a default value to the variable, within a SQL comment:
     142
     143{{{#!sql
     144-- PRIORITY = high
     145
     146SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
     147}}}
     148
     149
     150=== !Special/Constant Variables
     151
     152There is one dynamic variable whose value is set automatically (the URL does not have to be changed) to allow practical reports.
     153
     154 * $USER — Username of logged in user.
     155
     156Example: List all tickets assigned to me:
     157{{{#!sql
    147158SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
    148159}}}
    149160
    150 
    151 
    152 == 上級トピック: 表示形式のカスタマイズ == #AdvancedReports:CustomFormatting
    153 Trac には、レイアウトのカスタマイズや、グルーピング、ユーザ定義の CSS 利用などによる
    154 もっと複雑なレポートの作成も可能です。このようなレポートを作成するには、
    155 Trac のレポートエンジンが出力を制御するためのステートメントを含む、特別な SQL を使用します。
    156 
    157 === 特別なカラム === #SpecialColumns
    158 レポートを整形するため、 TracReports はクエリの結果から '特定の' カラム名を
    159 探します。このような '特定の' 名前で、最終的なレポートのレイアウトやスタイルが
    160 処理され、変更されます。
    161 
    162 === 自動的に整形されるカラム名 === #Automaticallyformattedcolumns
    163  * '''ticket''' — チケットの ID が入っているカラムで使用します。該当する ID のカラムにハイパーリンクされます (訳注: `summary` というカラム名もチケットにハイパーリンクされます。日本語版では `概要` でもリンクします)
    164  * '''id''' — '''realm''' が指定されない場合は、 '''ticket''' と同じです
    165  * '''realm''' — '''id''' と同時に使用します。チケット以外のリソースにリンクを行う場合に使用します(e.g. ''wiki'' のレルムに ''id'' としてページ名を組み合わせると、 Wiki ページへのリンクを生成します)
    166  * '''created, modified, date, time''' — 日付や時刻に整形されます (訳注: `datetime` という列名にすると日時で整形されます。日本語版では `時刻` で終わるカラムは `time` に、 `日付` で終わるカラムは `date` に、 `日時` で終わるカラムは `datetime` に、それぞれ整形されます)
    167  * '''description''' — チケットの説明が入っているカラムで使用します。 Wiki エンジンで処理されます (訳注: 日本語版では `説明` でも整形されます)
    168 
    169 '''例:'''
    170 {{{
    171 SELECT id AS ticket, created, status, summary FROM ticket
    172 }}}
    173 
    174 これらのカラムは定義しても非表示にすることができます。方法は [#column-syntax 下記] を参照してください。
    175 
    176 ''ticket'' 以外のレルムに対するレポートの作成方法については [trac:CookBook/Configuration/Reports CookBook/Configuration/Reports] を参照してください。
    177 
    178 '''訳注''': Trac-0.11.1.ja1 以降のバージョンで作成した Environment では、デフォルトのレポートに日本語での整形ルールが適用されています。このような Environment を本家版 Trac で使用したい場合は各レポートの SQL を編集し、上記の日本語のカラム別名を英語に変更してください。
    179 
    180 === 整形されるカラムのカスタマイズ === #Customformattingcolumns
    181 カラム名の前後に 2 つのアンダースコアがついている場合 (例: '''`__color__`''') は、
    182 ''整形用のヒント'' として扱われ、レコードの整形が行われます。
    183 
    184  * '''`__group__`''' — 指定されたカラムで、表示がグループ化されます。各グループは、それぞれセクションヘッダとクエリ結果の表を持ちます
    185  * '''`__grouplink__`''' — グループ化した場合の各グループのヘッダで生成するリンク先の URL を指定します。この URL は各グループの最初の行にだけ付与されます
    186  * '''`__color__`''' — 1 から 5 の数値である必要があります。値によって、あらかじめ定義された色付けが行われます。一般的な使用法は、優先度別の色付けです
     161== Advanced Reports: Custom Formatting
     162
     163Trac is also capable of more advanced reports, including custom layouts, result grouping and user-defined CSS styles. To create such reports, we will use specialized SQL statements to control the output of the Trac report engine.
     164
     165=== Special Columns
     166
     167To format reports, TracReports looks for 'magic' column names in the query result. These 'magic' names are processed and affect the layout and style of the final report.
     168
     169=== Automatically formatted columns
     170
     171 * '''ticket''' — Ticket ID number. Becomes a hyperlink to that ticket.
     172 * '''id''' — same as '''ticket''' above when '''realm''' is not set
     173 * '''realm''' — together with '''id''', can be used to create links to other resources than tickets (e.g. a realm of ''wiki'' and an ''id'' to a page name will create a link to that wiki page)
     174   - for some kind of resources, it may be necessary to specify their ''parent'' resources (e.g. for ''changeset'', which ''repos'') and this can be achieved using the '''parent_realm''' and '''parent_id''' columns
     175 * '''created, modified, date, time''' — Format cell as a date and/or time.
     176 * '''description''' — Ticket description field, parsed through the wiki engine.
     177
     178'''Example:'''
     179{{{#!sql
     180SELECT id AS ticket, created, status, summary FROM ticket
     181}}}
     182
     183Those columns can also be defined but marked as hidden, see [#column-syntax below].
     184
     185See trac:wiki/CookBook/Configuration/Reports for some example of creating reports for realms other than ''ticket''.
     186
     187=== Custom formatting columns
     188
     189Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
     190assumed to be ''formatting hints'', affecting the appearance of the row.
     191 
     192 * '''`__group__`''' — Group results based on values in this column. Each group will have its own header and table.
     193 * '''`__grouplink__`''' — Make the header of each group a link to the specified URL. The URL is taken from the first row of each group.
     194 * '''`__color__`''' — Should be a numeric value ranging from 1 to 5 to select a pre-defined row color. Typically used to color rows by issue priority.
    187195{{{
    188196#!html
    189 <div style="margin-left:7.5em">デフォルトの色付け:
     197<div style="margin-left:7.5em">Defaults:
    190198<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
    191199<span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
    … …  
    195203</div>
    196204}}}
    197  * '''`__style__`''' — `<tr>` 要素を使用して CSS 形式でレコードを整形できます
    198  * '''`__class__`''' — `<tr>` 要素でセットされた0以上の空白で区切られた CSS のクラス名です。これらのクラスは `__color__` に由来するクラス名と偶数/奇数の指標に追加されます
    199 
    200 '''例:''' ''マイルストーン別未解決チケット (優先度別色付け, グループのヘッダでマイルストーンにリンク)''
    201 {{{
     205 * '''`__style__`''' — A custom CSS style expression to use on the `<tr>` element of the current row.
     206 * '''`__class__`''' — Zero or more space-separated CSS class names to be set on the `<tr>` element of the current row. These classes are added to the class name derived from `__color__` and the odd / even indicator.
     207
     208'''Example:''' ''List active tickets, grouped by milestone, group header linked to milestone page, colored by priority''
     209{{{#!sql
    202210SELECT p.value AS __color__,
    203211     t.milestone AS __group__,
    204212     '../milestone/' || t.milestone AS __grouplink__,
    205213     (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
    206        t.id AS ticket, summary
    207   FROM ticket t,enum p
    208   WHERE t.status IN ('new', 'assigned', 'reopened')
    209     AND p.name=t.priority AND p.type='priority'
    210   ORDER BY t.milestone, p.value, t.severity, t.time
    211 }}}
    212 
    213 '''Note:''' ''ticket'' 表の優先度に対応する数値は、 ''enum'' 表を結合することで
    214 取り出しています。
    215 
    216 === 行単位のレイアウト変更 === #column-syntax
    217 デフォルトでは、全てのカラムで1行を使い、上記の指定がされていれば、
    218 フォーマットされた形式で HTML に表示されます。それだけでなく、
    219 これから挙げる指定によって、複数行にわたってのレイアウトを行うことができます。
    220 
    221  * '''`column_`''' — ''改行''。 カラム名の語尾にアンダースコア ('_') を付与した場合、以降のカラムは次の行で表示されます
    222 
    223  * '''`_column_`''' — ''全行表示''。 カラム名の前後にアンダースコア ('_') を付与した場合、そのカラムは続く行で全てのカラム幅を使って表示されます
    224 
    225  * '''`_column`'''  —  ''データを非表示にする''。 カラム名の語頭にアンダースコア ('_') を付与した場合、 HTML 出力では非表示になります。これは (CSV や RSS のような) 別フォーマットでのダウンロード時にだけ見たい情報であるときに使います
    226    この機能ではあらゆるカラムを非表示にできます。リソースの特定などで他のカラムが異存しているような場合に有用です。たとえば `id as _id` とすることで、 '''Id''' カラムは非表示となりますが、チケットへのリンクは正しく生成されます
    227 
    228 '''例:''' ''アクティブなチケットを、マイルストーンでグループ化し、優先度で色付け、チケットの説明を multi-line レイアウトでリスト表示する''
    229 
    230 {{{
     214     t.id AS ticket, summary
     215FROM ticket t,enum p
     216WHERE t.status IN ('new', 'assigned', 'reopened')
     217  AND p.name = t.priority AND p.type = 'priority'
     218ORDER BY t.milestone, p.value, t.severity, t.time
     219}}}
     220
     221'''Note:''' A table join is used to match ''ticket'' priorities with their numeric representation from the ''enum'' table.
     222
     223=== Changing layout of report rows === #column-syntax
     224
     225By default, all columns on each row are display on a single row in the HTML report, possibly formatted according to the descriptions above. However, it is also possible to create multi-line report entries.
     226
     227 * '''`column_`''' — ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be continued on a second line.
     228
     229 * '''`_column_`''' — ''Full row''. By adding an underscore ('_') both at the beginning and the end of a column name, the data will be shown on a separate row.
     230
     231 * '''`_column`''' — ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML).
     232   This can be used to hide any kind of column, even important ones required for identifying the resource, e.g. `id as _id` will hide the '''Id''' column but the link to the ticket will be present.
     233
     234'''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''
     235
     236{{{#!sql
    231237SELECT p.value AS __color__,
    232238       t.milestone AS __group__,
    233        (CASE owner
    234           WHEN 'daniel' THEN 'font-weight: bold; background: red;'
     239       (CASE owner 
     240          WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
    235241          ELSE '' END) AS __style__,
    236        t.id AS ticket, summary AS summary_,             -- ## ここで改行する
     242       t.id AS ticket, summary AS summary_,             -- ## Break line here
    237243       component,version, severity, milestone, status, owner,
    238        time AS created, changetime AS modified,         -- ## 日付形式で整形
    239        description AS _description_,                    -- ## 全行を使用して表示
    240        changetime AS _changetime, reporter AS _reporter -- ## HTML 出力では表示しない
    241   FROM ticket t,enum p
    242   WHERE t.status IN ('new', 'assigned', 'reopened')
    243     AND p.name=t.priority AND p.type='priority'
    244   ORDER BY t.milestone, p.value, t.severity, t.time
    245 }}}
    246 
    247 === カスタムフィールドをレポートで使用する === #Reportingoncustomfields
    248 
    249 チケットにカスタムフィールドを追加した場合(バージョン 0.8 以降の機能。 TracTicketsCustomFields 参照)、カスタムフィールドを含む SQL クエリを書くことができます。 ticket_custom テーブルを join をする必要がありますが、これは取り立てて簡単というわけではありません。
    250 
    251 追加のフィールドを trac.ini に宣言する ''前に'' 、チケットがデータベースに存在する場合、 ticket_custom テーブルには関連するデータを持たないことになります。これに起因する問題を回避するためには SQL の "LEFT OUTER JOIN" 節を使用してください。
    252 
    253 === SQLの書き換えについて #rewriting
    254 動的変数の比較的些細な変更によって、SQL クエリもレポートの2つの特徴のサポートのために変更されます:
    255  1. [#sort-order ソート順の変更]
    256  2. ページネーションのサポート (各ページの表示結果の行数の制約)
    257 一つ目の特徴をサポートするために、__group__｀カラムが指定される場合にはソートカラムは `ORDER BY` 節の中の先頭位置か二番目の位置に挿入されます(必要に応じて `ORDER BY` 節は作成されます)。 ページネーションをサポートするために、 `LIMIT ... OFFSET ...` 節が追加されます。
    258 クエリは自動書き換えの機能が正常に働くには複雑すぎて、クエリは間違った結果になるかもしれません。この場合、手動で下記のトークンを挿入することにより、書き直しがどのように行われるか正確にコントロールできる可能性があります:
    259  - `@SORT_COLUMN@`, ソートしたいカラム名です,
    260  - `@LIMIT_OFFSET@`, ページネーションのサポートの節です
    261 Note: もしSQLコメント `--` の後に記述すると、意図したとおりの書き換えが事実上不可能になります！
    262 
    263 SQL query の例:
    264 {{{
    265 -- ## 4: 担当者がアサインしたアクティブなチケット ## --
    266 
    267 --
    268 -- アサインされたチケットのリスト、チケットの担当者によるグループ化、優先度によるソート
    269 --
     244       time AS created, changetime AS modified,         -- ## Dates are formatted
     245       description AS _description_,                    -- ## Uses a full row
     246       changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
     247FROM ticket t,enum p
     248WHERE t.status IN ('new', 'assigned', 'reopened')
     249  AND p.name = t.priority AND p.type = 'priority'
     250ORDER BY t.milestone, p.value, t.severity, t.time
     251}}}
     252
     253=== Reporting on custom fields
     254
     255If you have added custom fields to your tickets (see TracTicketsCustomFields), you can write a SQL query to cover them. You'll need to make a join on the ticket_custom table, but this isn't especially easy.
     256
     257If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See [trac:TracIniReportCustomFieldSample TracIniReportCustomFieldSample] for some examples.
     258
     259=== A note about SQL rewriting #rewriting
     260
     261Beyond the relatively trivial replacement of dynamic variables, the SQL query is also altered in order to support two features of the reports:
     262 1. [#sort-order changing the sort order]
     263 1. pagination support (limitation of the number of result rows displayed on each page)
     264In order to support the first feature, the sort column is inserted in the `ORDER BY` clause in the first position or in the second position if a `__group__` column is specified (an `ORDER BY` clause is created if needed). In order to support pagination, a `LIMIT ... OFFSET ...` clause is appended.
     265The query might be too complex for the automatic rewrite to work correctly, resulting in an erroneous query. In this case you still have the possibility to control exactly how the rewrite is done by manually inserting the following tokens:
     266 - `@SORT_COLUMN@`, the place where the name of the selected sort column will be inserted,
     267 - `@LIMIT_OFFSET@`, the place where the pagination support clause will be added
     268Note that if you write them after an SQL comment, `--`, you'll effectively disable rewriting if this is what you want!
     269
     270Let's take an example, consider the following SQL query:
     271{{{#!sql
     272-- ## 4: Assigned, Active Tickets by Owner ## --
     273
     274--
     275-- List assigned tickets, group by ticket owner, sorted by priority.
     276--
    270277
    271278SELECT p.value AS __color__,
    … …  
    274281   changetime AS _changetime, description AS _description,
    275282   reporter AS _reporter
    276   FROM ticket t,enum p
    277   WHERE status = 'assigned'
    278 AND p.name=t.priority AND p.type='priority'
    279   ORDER BY __group__, p.value, severity, time
    280 }}}
    281 
    282 自動書き換えの例(1ページにつき4行、2ページ、`component` によるソート):
    283 {{{
     283FROM ticket t,enum p
     284WHERE status = 'assigned'
     285  AND p.name = t.priority AND p.type = 'priority'
     286ORDER BY __group__, p.value, severity, time
     287}}}
     288
     289The automatic rewrite will be the following (4 rows per page, page 2, sorted by `component`):
     290{{{#!sql
    284291SELECT p.value AS __color__,
    285292   owner AS __group__,
    … …  
    287294   changetime AS _changetime, description AS _description,
    288295   reporter AS _reporter
    289   FROM ticket t,enum p
    290   WHERE status = 'assigned'
    291 AND p.name=t.priority AND p.type='priority'
    292   ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
    293  LIMIT 4 OFFSET 4
    294 }}}
    295 
    296 書き換えのトークンと等しいSQLクエリの例:
    297 {{{
     296FROM ticket t,enum p
     297WHERE status = 'assigned'
     298  AND p.name = t.priority AND p.type = 'priority'
     299ORDER BY __group__ ASC, `component` ASC,  __group__, p.value, severity, time
     300LIMIT 4 OFFSET 4
     301}}}
     302
     303The equivalent SQL query with the rewrite tokens would have been:
     304{{{#!sql
    298305SELECT p.value AS __color__,
    299306   owner AS __group__,
    … …  
    301308   changetime AS _changetime, description AS _description,
    302309   reporter AS _reporter
    303   FROM ticket t,enum p
    304   WHERE status = 'assigned'
    305 AND p.name=t.priority AND p.type='priority'
    306   ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
     310FROM ticket t,enum p
     311WHERE status = 'assigned'
     312  AND p.name = t.priority AND p.type = 'priority'
     313ORDER BY __group__, @SORT_COLUMN@, p.value, severity, time
    307314@LIMIT_OFFSET@
    308315}}}
    309316
    310 もし、最初に常に優先度によるソートを、そしてその次にユーザが選択したカラムによるソートを希望するならば、シンプルに下記のように `ORDER BY` 節を使用してください:
    311 {{{
    312   ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
     317If you want to always sort first by priority and only then by the user selected sort column, simply use the following `ORDER BY` clause:
     318{{{#!sql
     319ORDER BY __group__, p.value, @SORT_COLUMN@, severity, time
    313320}}}
    314321