| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="generator" content="Asciidoctor 1.5.4"> |
| <title>Command Interface Guide</title> |
| <style> |
| /** |
| * @@@ START COPYRIGHT @@@ |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| * @@@ END COPYRIGHT @@@ |
| */ |
| /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ |
| /* Remove the comments around the @import statement below when using this as a custom stylesheet */ |
| /*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400";*/ |
| article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} |
| audio,canvas,video{display:inline-block} |
| audio:not([controls]){display:none;height:0} |
| [hidden],template{display:none} |
| script{display:none!important} |
| html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} |
| body{margin:0} |
| a{background:transparent} |
| a:focus{outline:thin dotted} |
| a:active,a:hover{outline:0} |
| h1{font-size:2em;margin:.67em 0} |
| abbr[title]{border-bottom:1px dotted} |
| b,strong{font-weight:bold} |
| dfn{font-style:italic} |
| hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} |
| mark{background:#ff0;color:#000} |
| code,kbd,pre,samp{font-family:monospace;font-size:1em} |
| pre{white-space:pre-wrap} |
| q{quotes:"\201C" "\201D" "\2018" "\2019"} |
| small{font-size:80%} |
| sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} |
| sup{top:-.5em} |
| sub{bottom:-.25em} |
| img{border:0} |
| svg:not(:root){overflow:hidden} |
| figure{margin:0} |
| fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} |
| legend{border:0;padding:0} |
| button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} |
| button,input{line-height:normal} |
| button,select{text-transform:none} |
| button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} |
| button[disabled],html input[disabled]{cursor:default} |
| input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} |
| input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} |
| input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} |
| button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} |
| textarea{overflow:auto;vertical-align:top} |
| table{border-collapse:collapse;border-spacing:0} |
| *,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} |
| html,body{font-size:100%} |
| body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif,serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} |
| a:hover{cursor:pointer} |
| img,object,embed{max-width:100%;height:auto} |
| object,embed{height:100%} |
| img{-ms-interpolation-mode:bicubic} |
| #map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} |
| .left{float:left!important} |
| .right{float:right!important} |
| .text-left{text-align:left!important} |
| .text-right{text-align:right!important} |
| .text-center{text-align:center!important} |
| .text-justify{text-align:justify!important} |
| .hide{display:none} |
| .antialiased,body{-webkit-font-smoothing:antialiased} |
| img{display:inline-block;vertical-align:middle} |
| textarea{height:auto;min-height:50px} |
| select{width:100%} |
| p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} |
| .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#3188ac;font-weight:400;margin-top:0;margin-bottom:.25em} |
| div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} |
| a{color:#2156a5;text-decoration:underline;line-height:inherit} |
| a:hover,a:focus{color:#1d4b8f} |
| a img{border:none} |
| p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} |
| p aside{font-size:.875em;line-height:1.35;font-style:italic} |
| /* Defines headings */ |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-weight:bold;font-style:normal;color:#3188ac;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} |
| h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} |
| h1{font-size:2.125em} |
| h2{font-size:1.6875em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} |
| h4,h5{font-size:1.125em} |
| h6{font-size:1em} |
| hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} |
| em,i{font-style:italic;line-height:inherit} |
| strong,b{font-weight:bold;line-height:inherit} |
| small{font-size:60%;line-height:inherit} |
| /* Defines the `text` (passthru) format */ |
| code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:bold;color:#3188ac} |
| ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} |
| ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} |
| ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} |
| ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} |
| ul.square{list-style-type:square} |
| ul.circle{list-style-type:circle} |
| ul.disc{list-style-type:disc} |
| ul.no-bullet{list-style:none} |
| ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} |
| dl dt{margin-bottom:.3125em;font-weight:bold} |
| dl dd{margin-bottom:1.25em} |
| abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} |
| abbr{text-transform:none} |
| blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} |
| blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} |
| blockquote cite:before{content:"\2014 \0020"} |
| blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} |
| blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} |
| @media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} |
| h1{font-size:2.75em} |
| h2{font-size:2.3125em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} |
| h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} |
| table thead,table tfoot{background:#f7f8f7;font-weight:bold} |
| table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} |
| table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} |
| table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} |
| table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} |
| h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} |
| .clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} |
| .clearfix:after,.float-group:after{clear:both} |
| *:not(pre)>code{font-size:1.0em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} |
| /**:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}*/ |
| pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} |
| .keyseq{color:rgba(51,51,51,.8)} |
| kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} |
| .keyseq kbd:first-child{margin-left:0} |
| .keyseq kbd:last-child{margin-right:0} |
| .menuseq,.menu{color:rgba(0,0,0,.8)} |
| b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} |
| b.button:before{content:"[";padding:0 3px 0 2px} |
| b.button:after{content:"]";padding:0 2px 0 3px} |
| p a>code:hover{color:rgba(0,0,0,.9)} |
| #header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} |
| #header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} |
| #header:after,#content:after,#footnotes:after,#footer:after{clear:both} |
| #content{margin-top:1.25em} |
| #content:before{content:none} |
| /* #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} */ |
| #header>h1:first-child{color:#3188ac;margin-top:2.25rem;margin-bottom:0} |
| #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} |
| #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} |
| #header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} |
| #header .details span:first-child{margin-left:-.125em} |
| #header .details span.email a{color:rgba(0,0,0,.85)} |
| #header .details br{display:none} |
| #header .details br+span:before{content:"\00a0\2013\00a0"} |
| #header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} |
| #header .details br+span#revremark:before{content:"\00a0|\00a0"} |
| #header #revnumber{text-transform:capitalize} |
| #header #revnumber:after{content:"\00a0"} |
| #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} |
| #toc{border-bottom:1px solid #efefed;padding-bottom:.5em} |
| #toc>ul{margin-left:.125em} |
| #toc ul.sectlevel0>li>a{font-style:italic} |
| #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} |
| #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} |
| #toc a{text-decoration:none} |
| #toc a:active{text-decoration:underline} |
| #toctitle{color:#3188ac;font-size:1.2em} |
| @media only screen and (min-width:768px){#toctitle{font-size:1.375em} |
| body.toc2{padding-left:15em;padding-right:0} |
| #toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} |
| #toc.toc2 #toctitle{margin-top:0;font-size:1.2em} |
| #toc.toc2>ul{font-size:.9em;margin-bottom:0} |
| #toc.toc2 ul ul{margin-left:0;padding-left:1em} |
| #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} |
| body.toc2.toc-right{padding-left:0;padding-right:15em} |
| body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} |
| /* Controls width of panel */ |
| #toc.toc2{width:20em} |
| #toc.toc2 #toctitle{font-size:1.375em} |
| #toc.toc2>ul{font-size:.95em} |
| #toc.toc2 ul ul{padding-left:1.25em} |
| body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} |
| #content #toc>:first-child{margin-top:0} |
| #content #toc>:last-child{margin-bottom:0} |
| #footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} |
| #footer-text,#footer_nav{color:rgba(255,255,255,.8);line-height:1.44} |
| #footer a{color: #990000} |
| .sect1{padding-bottom:.625em} |
| @media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} |
| #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} |
| #content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} |
| #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} |
| #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#990000;text-decoration:none} |
| #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} |
| .audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} |
| .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Helvetica Neue",Helvetica,Arial,sans-serif,serif;font-size:1rem;font-weight:bold} |
| /* Here */ |
| table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} |
| .paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} |
| table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} |
| .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} |
| .admonitionblock>table td.icon{text-align:center;width:80px} |
| .admonitionblock>table td.icon img{max-width:none} |
| .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} |
| .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} |
| .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} |
| .exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} |
| .exampleblock>.content>:first-child{margin-top:0} |
| .exampleblock>.content>:last-child{margin-bottom:0} |
| .sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} |
| .sidebarblock>:first-child{margin-top:0} |
| .sidebarblock>:last-child{margin-bottom:0} |
| .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} |
| .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} |
| .literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} |
| .sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} |
| .literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} |
| .literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} |
| @media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} |
| .listingblock pre.highlightjs{padding:0} |
| .listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} |
| .listingblock pre.prettyprint{border-width:0} |
| .listingblock>.content{position:relative} |
| .listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} |
| .listingblock:hover code[data-lang]:before{display:block} |
| .listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} |
| .listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} |
| table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} |
| table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} |
| table.pyhltable td.code{padding-left:.75em;padding-right:0} |
| pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} |
| pre.pygments .lineno{display:inline-block;margin-right:.25em} |
| table.pyhltable .linenodiv{background:none!important;padding-right:0!important} |
| .quoteblock{margin:0 1em 1.25em 1.5em;display:table} |
| .quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} |
| .quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} |
| .quoteblock blockquote{margin:0;padding:0;border:0} |
| .quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} |
| .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} |
| .quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} |
| .quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} |
| .quoteblock .quoteblock blockquote{padding:0 0 0 .75em} |
| .quoteblock .quoteblock blockquote:before{display:none} |
| .verseblock{margin:0 1em 1.25em 1em} |
| .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} |
| .verseblock pre strong{font-weight:400} |
| .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} |
| .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} |
| .quoteblock .attribution br,.verseblock .attribution br{display:none} |
| .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} |
| .quoteblock.abstract{margin:0 0 1.25em 0;display:block} |
| .quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} |
| .quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} |
| table.tableblock{max-width:100%;border-collapse:separate} |
| table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} |
| table.spread{width:100%} |
| table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} |
| table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} |
| table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} |
| table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} |
| table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} |
| table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} |
| table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} |
| table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} |
| table.frame-all{border-width:1px} |
| table.frame-sides{border-width:0 1px} |
| table.frame-topbot{border-width:1px 0} |
| th.halign-left,td.halign-left{text-align:left} |
| th.halign-right,td.halign-right{text-align:right} |
| th.halign-center,td.halign-center{text-align:center} |
| th.valign-top,td.valign-top{vertical-align:top} |
| th.valign-bottom,td.valign-bottom{vertical-align:bottom} |
| th.valign-middle,td.valign-middle{vertical-align:middle} |
| table thead th,table tfoot th{font-weight:bold} |
| tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} |
| tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} |
| p.tableblock>code:only-child{background:none;padding:0} |
| p.tableblock{font-size:1em} |
| td>div.verse{white-space:pre} |
| ol{margin-left:1.75em} |
| ul li ol{margin-left:1.5em} |
| dl dd{margin-left:1.125em} |
| dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} |
| ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} |
| ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} |
| ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} |
| ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1em;font-size:.85em} |
| ul.checklist li>p:first-child>input[type="checkbox"]:first-child{width:1em;position:relative;top:1px} |
| ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} |
| ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} |
| ul.inline>li>*{display:block} |
| .unstyled dl dt{font-weight:400;font-style:normal} |
| ol.arabic{list-style-type:decimal} |
| ol.decimal{list-style-type:decimal-leading-zero} |
| ol.loweralpha{list-style-type:lower-alpha} |
| ol.upperalpha{list-style-type:upper-alpha} |
| ol.lowerroman{list-style-type:lower-roman} |
| ol.upperroman{list-style-type:upper-roman} |
| ol.lowergreek{list-style-type:lower-greek} |
| .hdlist>table,.colist>table{border:0;background:none} |
| .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} |
| td.hdlist1{padding-right:.75em;font-weight:bold} |
| td.hdlist1,td.hdlist2{vertical-align:top} |
| .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} |
| .colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} |
| .colist>table tr>td:last-of-type{padding:.25em 0} |
| .thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} |
| .imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} |
| .imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} |
| .imageblock>.title{margin-bottom:0} |
| .imageblock.thumb,.imageblock.th{border-width:6px} |
| .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} |
| .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} |
| .image.left{margin-right:.625em} |
| .image.right{margin-left:.625em} |
| a.image{text-decoration:none} |
| span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} |
| span.footnote a,span.footnoteref a{text-decoration:none} |
| span.footnote a:active,span.footnoteref a:active{text-decoration:underline} |
| #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} |
| #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} |
| #footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} |
| #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} |
| #footnotes .footnote:last-of-type{margin-bottom:0} |
| #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} |
| .gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} |
| .gist .file-data>table td.line-data{width:99%} |
| div.unbreakable{page-break-inside:avoid} |
| .big{font-size:larger} |
| .small{font-size:smaller} |
| .underline{text-decoration:underline} |
| .overline{text-decoration:overline} |
| .line-through{text-decoration:line-through} |
| .aqua{color:#00bfbf} |
| .aqua-background{background-color:#00fafa} |
| .black{color:#000} |
| .black-background{background-color:#000} |
| .blue{color:#0000bf} |
| .blue-background{background-color:#0000fa} |
| .fuchsia{color:#bf00bf} |
| .fuchsia-background{background-color:#fa00fa} |
| .gray{color:#606060} |
| .gray-background{background-color:#7d7d7d} |
| .green{color:#006000} |
| .green-background{background-color:#007d00} |
| .lime{color:#00bf00} |
| .lime-background{background-color:#00fa00} |
| .maroon{color:#600000} |
| .maroon-background{background-color:#7d0000} |
| .navy{color:#000060} |
| .navy-background{background-color:#00007d} |
| .olive{color:#606000} |
| .olive-background{background-color:#7d7d00} |
| .purple{color:#600060} |
| .purple-background{background-color:#7d007d} |
| .red{color:#bf0000} |
| .red-background{background-color:#fa0000} |
| .silver{color:#909090} |
| .silver-background{background-color:#bcbcbc} |
| .teal{color:#006060} |
| .teal-background{background-color:#007d7d} |
| .white{color:#bfbfbf} |
| .white-background{background-color:#fafafa} |
| .yellow{color:#bfbf00} |
| .yellow-background{background-color:#fafa00} |
| span.icon>.fa{cursor:default} |
| .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} |
| .admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} |
| .admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} |
| .admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} |
| .admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} |
| .admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} |
| .conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} |
| .conum[data-value] *{color:#fff!important} |
| .conum[data-value]+b{display:none} |
| .conum[data-value]:after{content:attr(data-value)} |
| pre .conum[data-value]{position:relative;top:-.125em} |
| b.conum *{color:inherit!important} |
| .conum:not([data-value]):empty{display:none} |
| h1,h2{letter-spacing:-.01em} |
| dt,th.tableblock,td.content{text-rendering:optimizeLegibility} |
| p,td.content{letter-spacing:-.01em} |
| p strong,td.content strong{letter-spacing:-.005em} |
| p,blockquote,dt,td.content{font-size:1.0625rem} |
| p{margin-bottom:1.25rem} |
| .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} |
| .exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} |
| .print-only{display:none!important} |
| @media print{@page{margin:1.25cm .75cm} |
| *{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} |
| a{color:inherit!important;text-decoration:underline!important} |
| a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} |
| a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} |
| abbr[title]:after{content:" (" attr(title) ")"} |
| pre,blockquote,tr,img{page-break-inside:avoid} |
| thead{display:table-header-group} |
| img{max-width:100%!important} |
| p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} |
| h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} |
| #toc,.sidebarblock,.exampleblock>.content{background:none!important} |
| #toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} |
| .sect1{padding-bottom:0!important} |
| .sect1+.sect1{border:0!important} |
| #header>h1:first-child{margin-top:1.25rem} |
| body.book #header{text-align:center} |
| body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} |
| body.book #header .details{border:0!important;display:block;padding:0!important} |
| body.book #header .details span:first-child{margin-left:0!important} |
| body.book #header .details br{display:block} |
| body.book #header .details br+span:before{content:none!important} |
| body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} |
| body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} |
| .listingblock code[data-lang]:before{display:block} |
| #footer{background:none!important;padding:0 .9375em} |
| #footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} |
| .hide-on-print{display:none!important} |
| .print-only{display:block!important} |
| .hide-for-print{display:none!important} |
| .show-for-print{display:inherit!important}} |
| div.paragraph.indented p {padding-left: 3em;} |
| div.paragraph.indented2 p {padding-left: 6em;} |
| div.paragraph.indented3 p {padding-left: 9em;} |
| |
| </style> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.5.0/css/font-awesome.min.css"> |
| <style> |
| /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ |
| /*pre.CodeRay {background-color:#f7f7f8;}*/ |
| .CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} |
| .CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} |
| .CodeRay .line-numbers strong{color:rgba(0,0,0,.4)} |
| table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} |
| table.CodeRay td{vertical-align: top;line-height:1.45} |
| table.CodeRay td.line-numbers{text-align:right} |
| table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} |
| table.CodeRay td.code{padding:0 0 0 .5em} |
| table.CodeRay td.code>pre{padding:0} |
| .CodeRay .debug{color:#fff !important;background:#000080 !important} |
| .CodeRay .annotation{color:#007} |
| .CodeRay .attribute-name{color:#000080} |
| .CodeRay .attribute-value{color:#700} |
| .CodeRay .binary{color:#509} |
| .CodeRay .comment{color:#998;font-style:italic} |
| .CodeRay .char{color:#04d} |
| .CodeRay .char .content{color:#04d} |
| .CodeRay .char .delimiter{color:#039} |
| .CodeRay .class{color:#458;font-weight:bold} |
| .CodeRay .complex{color:#a08} |
| .CodeRay .constant,.CodeRay .predefined-constant{color:#008080} |
| .CodeRay .color{color:#099} |
| .CodeRay .class-variable{color:#369} |
| .CodeRay .decorator{color:#b0b} |
| .CodeRay .definition{color:#099} |
| .CodeRay .delimiter{color:#000} |
| .CodeRay .doc{color:#970} |
| .CodeRay .doctype{color:#34b} |
| .CodeRay .doc-string{color:#d42} |
| .CodeRay .escape{color:#666} |
| .CodeRay .entity{color:#800} |
| .CodeRay .error{color:#808} |
| .CodeRay .exception{color:inherit} |
| .CodeRay .filename{color:#099} |
| .CodeRay .function{color:#900;font-weight:bold} |
| .CodeRay .global-variable{color:#008080} |
| .CodeRay .hex{color:#058} |
| .CodeRay .integer,.CodeRay .float{color:#099} |
| .CodeRay .include{color:#555} |
| .CodeRay .inline{color:#000} |
| .CodeRay .inline .inline{background:#ccc} |
| .CodeRay .inline .inline .inline{background:#bbb} |
| .CodeRay .inline .inline-delimiter{color:#d14} |
| .CodeRay .inline-delimiter{color:#d14} |
| .CodeRay .important{color:#555;font-weight:bold} |
| .CodeRay .interpreted{color:#b2b} |
| .CodeRay .instance-variable{color:#008080} |
| .CodeRay .label{color:#970} |
| .CodeRay .local-variable{color:#963} |
| .CodeRay .octal{color:#40e} |
| .CodeRay .predefined{color:#369} |
| .CodeRay .preprocessor{color:#579} |
| .CodeRay .pseudo-class{color:#555} |
| .CodeRay .directive{font-weight:bold} |
| .CodeRay .type{font-weight:bold} |
| .CodeRay .predefined-type{color:inherit} |
| .CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} |
| .CodeRay .key{color:#808} |
| .CodeRay .key .delimiter{color:#606} |
| .CodeRay .key .char{color:#80f} |
| .CodeRay .value{color:#088} |
| .CodeRay .regexp .delimiter{color:#808} |
| .CodeRay .regexp .content{color:#808} |
| .CodeRay .regexp .modifier{color:#808} |
| .CodeRay .regexp .char{color:#d14} |
| .CodeRay .regexp .function{color:#404;font-weight:bold} |
| .CodeRay .string{color:#d20} |
| .CodeRay .string .string .string{background:#ffd0d0} |
| .CodeRay .string .content{color:#d14} |
| .CodeRay .string .char{color:#d14} |
| .CodeRay .string .delimiter{color:#d14} |
| .CodeRay .shell{color:#d14} |
| .CodeRay .shell .delimiter{color:#d14} |
| .CodeRay .symbol{color:#990073} |
| .CodeRay .symbol .content{color:#a60} |
| .CodeRay .symbol .delimiter{color:#630} |
| .CodeRay .tag{color:#008080} |
| .CodeRay .tag-special{color:#d70} |
| .CodeRay .variable{color:#036} |
| .CodeRay .insert{background:#afa} |
| .CodeRay .delete{background:#faa} |
| .CodeRay .change{color:#aaf;background:#007} |
| .CodeRay .head{color:#f8f;background:#505} |
| .CodeRay .insert .insert{color:#080} |
| .CodeRay .delete .delete{color:#800} |
| .CodeRay .change .change{color:#66f} |
| .CodeRay .head .head{color:#f4f} |
| </style> |
| </head> |
| <body class="book toc2 toc-left"> |
| <div id="header"> |
| <h1>Command Interface Guide</h1> |
| <div class="details"> |
| <span id="revnumber">version 2.4.0</span> |
| </div> |
| <div id="toc" class="toc2"> |
| <div id="toctitle">Table of Contents</div> |
| <ul class="sectlevel1"> |
| <li><a href="#_about_this_document">1. About This Document</a> |
| <ul class="sectlevel2"> |
| <li><a href="#_intended_audience">1.1. Intended Audience</a></li> |
| <li><a href="#_new_and_changed_information">1.2. New and Changed Information</a></li> |
| <li><a href="#_notation_conventions">1.3. Notation Conventions</a></li> |
| <li><a href="#_comments_encouraged">1.4. Comments Encouraged</a></li> |
| </ul> |
| </li> |
| <li><a href="#_introduction">2. Introduction</a></li> |
| <li><a href="#install">3. Install and Configure</a> |
| <ul class="sectlevel2"> |
| <li><a href="#_install_trafci">3.1. Install trafci</a></li> |
| <li><a href="#_test_trafci_launch">3.2. Test trafci Launch</a></li> |
| </ul> |
| </li> |
| <li><a href="#_launch_trafci">4. Launch trafci</a> |
| <ul class="sectlevel2"> |
| <li><a href="#_launch_trafci_on_windows_workstation">4.1. Launch trafci on Windows Workstation</a> |
| <ul class="sectlevel3"> |
| <li><a href="#trafci_shortcut">4.1.1. Create <code>trafci.cmd</code> Shortcut</a></li> |
| </ul> |
| </li> |
| <li><a href="#_launch_trafci_on_linux_workstation">4.2. Launch trafci on Linux Workstation</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_set_code_trafci_sh_code_path">4.2.1. Set <code>trafci.sh</code> PATH</a></li> |
| <li><a href="#trafci_preset">4.2.2. Preset the Optional Launch Parameters</a></li> |
| </ul> |
| </li> |
| <li><a href="#trafci_login">4.3. Log In to Database Platform</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_log_in_without_login_parameters">4.3.1. Log In Without Login Parameters</a></li> |
| <li><a href="#trafci_login_params">4.3.2. Use Login Parameters</a></li> |
| </ul> |
| </li> |
| <li><a href="#trafci_retry">4.4. Retry Login</a></li> |
| <li><a href="#trafci_option_params">4.5. Optional Launch Parameters</a></li> |
| <li><a href="#trafci_run_command">4.6. Run Command When Launching trafci</a></li> |
| <li><a href="#trafci_run_script">4.7. Run Script When Launching trafci</a></li> |
| <li><a href="#trafci_noconnect">4.8. Launch trafci Without Connecting to the Database</a></li> |
| <li><a href="#trafci_with_version">4.9. Run trafci With <code>-version</code></a></li> |
| <li><a href="#trafci_help">4.10. Run trafci With -help</a></li> |
| <li><a href="#trafci_quit">4.11. Exit trafci</a></li> |
| </ul> |
| </li> |
| <li><a href="#_run_commands_interactively">5. Run Commands Interactively</a> |
| <ul class="sectlevel2"> |
| <li><a href="#_user_interface">5.1. User Interface</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_product_banner">5.1.1. Product Banner</a></li> |
| <li><a href="#_interface_prompt">5.1.2. Interface Prompt</a></li> |
| <li><a href="#_break_the_command_line">5.1.3. Break the Command Line</a></li> |
| <li><a href="#_case_sensitivity">5.1.4. Case Sensitivity</a></li> |
| </ul> |
| </li> |
| <li><a href="#_interface_commands">5.2. Interface Commands</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_show_session_attributes">5.2.1. Show Session Attributes</a></li> |
| <li><a href="#interactive_idle_timeout">5.2.2. Set and Show Session Idle Timeout Value</a></li> |
| <li><a href="#interactive_customize_prompt">5.2.3. Customize the Standard Prompt</a></li> |
| <li><a href="#interactive_set_show_terminator">5.2.4. Set and Show the SQL Terminator</a></li> |
| <li><a href="#interactive_display_elapsed_time">5.2.5. Display the Elapsed Time</a></li> |
| <li><a href="#interactive_set_show_current_schema">5.2.6. Set and Show the Current Schema</a></li> |
| <li><a href="#_limit_query_result_set">5.2.7. Limit Query Result Set</a></li> |
| <li><a href="#interactive_history">5.2.8. Display Executed Commands</a></li> |
| <li><a href="#edit_reexecute_command">5.2.9. Edit and Reexecute a Command</a></li> |
| <li><a href="#_clear_the_interface_window">5.2.10. Clear the Interface Window</a></li> |
| <li><a href="#_obtain_help">5.2.11. Obtain Help</a></li> |
| </ul> |
| </li> |
| <li><a href="#_run_sql_statements">5.3. Run SQL Statements</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_execute_an_sql_statement">5.3.1. Execute an SQL Statement</a></li> |
| <li><a href="#_repeat_an_sql_statement">5.3.2. Repeat an SQL Statement</a></li> |
| <li><a href="#_prepare_and_execute_sql_statements">5.3.3. Prepare and Execute SQL Statements</a></li> |
| <li><a href="#_execute_a_prepared_sql_statement">5.3.4. Execute a Prepared SQL Statement</a></li> |
| </ul> |
| </li> |
| <li><a href="#interactive_log_output">5.4. Log Output</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_start_the_logging_process">5.4.1. Start the Logging Process</a></li> |
| <li><a href="#__code_spool_em_log_file_em_code_or_code_log_em_log_file_em_code_command">5.4.2. <code>SPOOL <em>log-file</em></code> or <code>LOG <em>log-file</em></code> Command</a></li> |
| <li><a href="#_stopping_the_logging_process">5.4.3. Stopping the Logging Process</a></li> |
| <li><a href="#_view_the_contents_of_a_log_file">5.4.4. View the Contents of a Log File</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li><a href="#_run_scripts">6. Run Scripts</a> |
| <ul class="sectlevel2"> |
| <li><a href="#script_create">6.1. Create a Script File</a></li> |
| <li><a href="#script_sql_statements">6.2. SQL Statements</a></li> |
| <li><a href="#script_commands">6.3. Commands</a></li> |
| <li><a href="#script_comments">6.4. Comments</a></li> |
| <li><a href="#script_section_headers">6.5. Section Headers</a></li> |
| <li><a href="#script_example">6.6. Example Script File</a></li> |
| <li><a href="#_run_a_script_file">6.7. Run a Script File</a></li> |
| <li><a href="#_log_output">6.8. Log Output</a></li> |
| <li><a href="#_run_scripts_in_parallel">6.9. Run Scripts in Parallel</a></li> |
| </ul> |
| </li> |
| <li><a href="#_run_trafci_from_perl_or_python">7. Run trafci From Perl or Python</a> |
| <ul class="sectlevel2"> |
| <li><a href="#_set_the_login_environment_variables">7.1. Set the Login Environment Variables</a> |
| <ul class="sectlevel3"> |
| <li><a href="#perlpython_env_windows">7.1.1. Set the Login Environment Variables on Windows</a></li> |
| <li><a href="#_set_login_environment_variables_in_the_system_properties">7.1.2. Set Login Environment Variables in the System Properties</a></li> |
| <li><a href="#perlpython_env_linux">7.1.3. Set the Login Environment Variables on Linux or UNIX</a></li> |
| </ul> |
| </li> |
| <li><a href="#_perl_and_python_wrapper_scripts">7.2. Perl and Python Wrapper Scripts</a></li> |
| <li><a href="#_launch_trafci_from_the_perl_or_python_command_line">7.3. Launch trafci From the Perl or Python Command Line</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_example_perl_program_code_sample_pl_code">7.3.1. Example Perl Program (<code>sample.pl</code>)</a></li> |
| <li><a href="#_example_python_program_code_sample_py_code">7.3.2. Example Python Program (<code>sample.py</code>)</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li><a href="#commands">8. Commands</a> |
| <ul class="sectlevel2"> |
| <li><a href="#cmd_at_sign">8.1. @ Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax">8.1.1. Syntax</a></li> |
| <li><a href="#_considerations">8.1.2. Considerations</a></li> |
| <li><a href="#_examples">8.1.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_slash">8.2. / Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_2">8.2.1. Syntax</a></li> |
| <li><a href="#_considerations_2">8.2.2. Considerations</a></li> |
| <li><a href="#_example">8.2.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_alias">8.3. ALIAS Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_3">8.3.1. Syntax</a></li> |
| <li><a href="#_considerations_3">8.3.2. Considerations</a></li> |
| <li><a href="#_examples_2">8.3.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_clear">8.4. CLEAR Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_4">8.4.1. Syntax</a></li> |
| <li><a href="#_considerations_4">8.4.2. Considerations</a></li> |
| <li><a href="#_example_2">8.4.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_connect">8.5. CONNECT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_5">8.5.1. Syntax</a></li> |
| <li><a href="#_considerations_5">8.5.2. Considerations</a></li> |
| <li><a href="#_examples_3">8.5.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_delay">8.6. DELAY Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_6">8.6.1. Syntax</a></li> |
| <li><a href="#_considerations_6">8.6.2. Considerations</a></li> |
| <li><a href="#_examples_4">8.6.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_disconnect">8.7. DISCONNECT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_7">8.7.1. Syntax</a></li> |
| <li><a href="#_considerations_7">8.7.2. Considerations</a></li> |
| <li><a href="#_examples_5">8.7.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_env">8.8. ENV Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_8">8.8.1. Syntax</a></li> |
| <li><a href="#_considerations_8">8.8.2. Considerations</a></li> |
| <li><a href="#_examples_6">8.8.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_exit">8.9. EXIT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_9">8.9.1. Syntax</a></li> |
| <li><a href="#_considerations_9">8.9.2. Considerations</a></li> |
| <li><a href="#_examples_7">8.9.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_fc">8.10. FC Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_10">8.10.1. Syntax</a></li> |
| <li><a href="#_considerations_10">8.10.2. Considerations</a></li> |
| <li><a href="#_examples_8">8.10.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_get_statistics">8.11. GET STATISTICS Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_11">8.11.1. Syntax</a></li> |
| <li><a href="#_description_of_returned_values">8.11.2. Description of Returned Values</a></li> |
| <li><a href="#_considerations_11">8.11.3. Considerations</a></li> |
| <li><a href="#_examples_9">8.11.4. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_goto">8.12. GOTO Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_12">8.12.1. Syntax</a></li> |
| <li><a href="#_considerations_12">8.12.2. Considerations</a></li> |
| <li><a href="#_examples_10">8.12.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_help">8.13. HELP Command</a></li> |
| <li><a href="#_syntax_13">8.14. Syntax</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_considerations_13">8.14.1. Considerations</a></li> |
| <li><a href="#_examples_11">8.14.2. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_history">8.15. HISTORY Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_14">8.15.1. Syntax</a></li> |
| <li><a href="#_considerations_14">8.15.2. Considerations</a></li> |
| <li><a href="#_example_3">8.15.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_if_then">8.16. IF…THEN Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_15">8.16.1. Syntax</a></li> |
| <li><a href="#_considerations_15">8.16.2. Considerations</a></li> |
| <li><a href="#_examples_12">8.16.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_label">8.17. LABEL Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_16">8.17.1. Syntax</a></li> |
| <li><a href="#_considerations_16">8.17.2. Considerations</a></li> |
| <li><a href="#_examples_13">8.17.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_localhost">8.18. LOCALHOST Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_17">8.18.1. Syntax</a></li> |
| <li><a href="#_considerations_17">8.18.2. Considerations</a></li> |
| <li><a href="#_examples_14">8.18.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_log">8.19. LOG Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_18">8.19.1. Syntax</a></li> |
| <li><a href="#_considerations_18">8.19.2. Considerations</a></li> |
| <li><a href="#_examples_15">8.19.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_obey">8.20. OBEY Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_19">8.20.1. Syntax</a></li> |
| <li><a href="#_considerations_19">8.20.2. Considerations</a></li> |
| <li><a href="#_examples_16">8.20.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#_prun_command">8.21. PRUN Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_20">8.21.1. Syntax</a></li> |
| <li><a href="#_considerations_20">8.21.2. Considerations</a></li> |
| <li><a href="#_examples_17">8.21.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_quit">8.22. QUIT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_21">8.22.1. Syntax</a></li> |
| <li><a href="#_considerations_21">8.22.2. Considerations</a></li> |
| <li><a href="#_examples_18">8.22.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_reconnect">8.23. RECONNECT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_22">8.23.1. Syntax</a></li> |
| <li><a href="#_considerations_22">8.23.2. Considerations</a></li> |
| <li><a href="#_examples_19">8.23.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_repeat">8.24. REPEAT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_23">8.24.1. Syntax</a></li> |
| </ul> |
| </li> |
| <li><a href="#_considerations_23">8.25. Considerations</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_examples_20">8.25.1. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_reset_lasterror">8.26. RESET LASTERROR Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_24">8.26.1. Syntax</a></li> |
| <li><a href="#_considerations_24">8.26.2. Considerations</a></li> |
| <li><a href="#_examples_21">8.26.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_reset_param">8.27. RESET PARAM Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_25">8.27.1. Syntax</a></li> |
| <li><a href="#_considerations_25">8.27.2. Considerations</a></li> |
| <li><a href="#_example_4">8.27.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_run">8.28. RUN Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_26">8.28.1. Syntax</a></li> |
| <li><a href="#_considerations_26">8.28.2. Considerations</a></li> |
| <li><a href="#_example_5">8.28.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_savehist">8.29. SAVEHIST Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_27">8.29.1. Syntax</a></li> |
| <li><a href="#_considerations_27">8.29.2. Considerations</a></li> |
| <li><a href="#_examples_22">8.29.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_colsep">8.30. SET COLSEP Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_28">8.30.1. Syntax</a></li> |
| <li><a href="#_considerations_28">8.30.2. Considerations</a></li> |
| <li><a href="#_examples_23">8.30.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_fetchsize">8.31. SET FETCHSIZE Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_29">8.31.1. Syntax</a></li> |
| <li><a href="#_considerations_29">8.31.2. Considerations</a></li> |
| <li><a href="#_examples_24">8.31.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#set_histopt">8.32. SET HISTOPT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_30">8.32.1. Syntax</a></li> |
| <li><a href="#_considerations_30">8.32.2. Considerations</a></li> |
| <li><a href="#_examples_25">8.32.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_idletimeout">8.33. SET IDLETIMEOUT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_31">8.33.1. Syntax</a></li> |
| <li><a href="#_considerations_31">8.33.2. Considerations</a></li> |
| <li><a href="#_examples_26">8.33.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_list_count">8.34. SET LIST_COUNT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_32">8.34.1. Syntax</a></li> |
| <li><a href="#_considerations_32">8.34.2. Considerations</a></li> |
| <li><a href="#_examples_27">8.34.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_markup">8.35. SET MARKUP Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_33">8.35.1. Syntax</a></li> |
| <li><a href="#_considerations_33">8.35.2. Considerations</a></li> |
| <li><a href="#_examples_28">8.35.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_param">8.36. SET PARAM Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_34">8.36.1. Syntax</a></li> |
| <li><a href="#_considerations_34">8.36.2. Considerations</a></li> |
| <li><a href="#_examples_29">8.36.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_prompt">8.37. SET PROMPT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_35">8.37.1. Syntax</a></li> |
| <li><a href="#_considerations_35">8.37.2. Considerations</a></li> |
| <li><a href="#_examples_30">8.37.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#_set_sqlprompt_command">8.38. SET SQLPROMPT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_36">8.38.1. Syntax</a></li> |
| <li><a href="#_considerations_36">8.38.2. Considerations</a></li> |
| <li><a href="#_examples_31">8.38.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_sqlterminator">8.39. SET SQLTERMINATOR Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_37">8.39.1. Syntax</a></li> |
| <li><a href="#_considerations_37">8.39.2. Considerations</a></li> |
| <li><a href="#_examples_32">8.39.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_statistics">8.40. SET STATISTICS Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_38">8.40.1. Syntax</a></li> |
| <li><a href="#_considerations_38">8.40.2. Considerations</a></li> |
| <li><a href="#_examples_33">8.40.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_time">8.41. SET TIME Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_39">8.41.1. Syntax</a></li> |
| <li><a href="#_considerations_39">8.41.2. Considerations</a></li> |
| <li><a href="#_examples_34">8.41.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_timing">8.42. SET TIMING Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_40">8.42.1. Syntax</a></li> |
| <li><a href="#_considerations_40">8.42.2. Considerations</a></li> |
| <li><a href="#_examples_35">8.42.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_activitycount">8.43. SHOW ACTIVITYCOUNT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_41">8.43.1. Syntax</a></li> |
| <li><a href="#_examples_36">8.43.2. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_alias">8.44. SHOW ALIAS Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_42">8.44.1. Syntax</a></li> |
| <li><a href="#_considerations_41">8.44.2. Considerations</a></li> |
| <li><a href="#_examples_37">8.44.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_aliases">8.45. SHOW ALIASES Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_43">8.45.1. Syntax</a></li> |
| <li><a href="#_considerations_42">8.45.2. Considerations</a></li> |
| <li><a href="#_examples_38">8.45.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_catalog">8.46. SHOW CATALOG Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_44">8.46.1. Syntax</a></li> |
| <li><a href="#_considerations_43">8.46.2. Considerations</a></li> |
| <li><a href="#_example_6">8.46.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_colsep">8.47. SHOW COLSEP Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_45">8.47.1. Syntax</a></li> |
| <li><a href="#_considerations_44">8.47.2. Considerations</a></li> |
| <li><a href="#_examples_39">8.47.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_errorcode">8.48. SHOW ERRORCODE Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_46">8.48.1. Syntax</a></li> |
| <li><a href="#_examples_40">8.48.2. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_fetchsize">8.49. SHOW FETCHSIZE Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_47">8.49.1. Syntax</a></li> |
| <li><a href="#_considerations_45">8.49.2. Considerations</a></li> |
| <li><a href="#_examples_41">8.49.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_histopt">8.50. SHOW HISTOPT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_48">8.50.1. Syntax</a></li> |
| <li><a href="#_considerations_46">8.50.2. Considerations</a></li> |
| <li><a href="#_examples_42">8.50.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_idletimeout">8.51. SHOW IDLETIMEOUT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_49">8.51.1. Syntax</a></li> |
| <li><a href="#_considerations_47">8.51.2. Considerations</a></li> |
| <li><a href="#_examples_43">8.51.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_lasterror">8.52. SHOW LASTERROR Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_50">8.52.1. Syntax</a></li> |
| <li><a href="#_considerations_48">8.52.2. Considerations</a></li> |
| <li><a href="#_examples_44">8.52.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_list_count">8.53. SHOW LIST_COUNT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_51">8.53.1. Syntax</a></li> |
| <li><a href="#_considerations_49">8.53.2. Considerations</a></li> |
| <li><a href="#_examples_45">8.53.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_markup">8.54. SHOW MARKUP Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_52">8.54.1. Syntax</a></li> |
| <li><a href="#_considerations_50">8.54.2. Considerations</a></li> |
| <li><a href="#_examples_46">8.54.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_param">8.55. SHOW PARAM Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_53">8.55.1. Syntax</a></li> |
| <li><a href="#_considerations_51">8.55.2. Considerations</a></li> |
| <li><a href="#_example_7">8.55.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_prepared">8.56. SHOW PREPARED Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_54">8.56.1. Syntax</a></li> |
| <li><a href="#_considerations_52">8.56.2. Considerations</a></li> |
| <li><a href="#_examples_47">8.56.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_reccount">8.57. SHOW RECCOUNT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_55">8.57.1. Syntax</a></li> |
| <li><a href="#_considerations_53">8.57.2. Considerations</a></li> |
| <li><a href="#_examples_48">8.57.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_remoteprocess">8.58. SHOW REMOTEPROCESS Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_56">8.58.1. Syntax</a></li> |
| <li><a href="#_considerations_54">8.58.2. Considerations</a></li> |
| <li><a href="#_example_8">8.58.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_schema">8.59. SHOW SCHEMA Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_57">8.59.1. Syntax</a></li> |
| <li><a href="#_considerations_55">8.59.2. Considerations</a></li> |
| <li><a href="#_example_9">8.59.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_session">8.60. SHOW SESSION Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_58">8.60.1. Syntax</a></li> |
| <li><a href="#_considerations_56">8.60.2. Considerations</a></li> |
| <li><a href="#_examples_49">8.60.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_set_sqlprompt">8.61. SHOW SQLPROMPT Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_59">8.61.1. Syntax</a></li> |
| <li><a href="#_considerations_57">8.61.2. Considerations</a></li> |
| <li><a href="#_example_10">8.61.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_sqlterminator">8.62. SHOW SQLTERMINATOR Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_60">8.62.1. Syntax</a></li> |
| <li><a href="#_considerations_58">8.62.2. Considerations</a></li> |
| <li><a href="#_example_11">8.62.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_statistics">8.63. SHOW STATISTICS Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_61">8.63.1. Syntax</a></li> |
| <li><a href="#_considerations_59">8.63.2. Considerations</a></li> |
| <li><a href="#_example_12">8.63.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_time">8.64. SHOW TIME Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_62">8.64.1. Syntax</a></li> |
| <li><a href="#_considerations_60">8.64.2. Considerations</a></li> |
| <li><a href="#_example_13">8.64.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_show_timing">8.65. SHOW TIMING Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_63">8.65.1. Syntax</a></li> |
| <li><a href="#_considerations_61">8.65.2. Considerations</a></li> |
| <li><a href="#_example_14">8.65.3. Example</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_spool">8.66. SPOOL Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_64">8.66.1. Syntax</a></li> |
| <li><a href="#_considerations_62">8.66.2. Considerations</a></li> |
| <li><a href="#_examples_50">8.66.3. Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="#cmd_version">8.67. VERSION Command</a> |
| <ul class="sectlevel3"> |
| <li><a href="#_syntax_65">8.67.1. Syntax</a></li> |
| <li><a href="#_considerations_63">8.67.2. Considerations</a></li> |
| <li><a href="#_example_15">8.67.3. Example</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div id="content"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><strong>License Statement</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at <a href="http://www.apache.org/licenses/LICENSE-2.0" class="bare">http://www.apache.org/licenses/LICENSE-2.0</a></p> |
| </div> |
| <div class="paragraph"> |
| <p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations under the License.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p><strong>Acknowledgements</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Microsoft®, Windows®, Windows NT®, Windows® XP, and Windows Vista® are |
| U.S. registered trademarks of Microsoft Corporation. Intel® and Intel® |
| Itanium® are trademarks of Intel Corporation in the U.S. and other |
| countries. Java® is a registered trademark of Oracle and/or its |
| affiliates. Motif, OSF/1, UNIX®, X/Open®, and the X device is a |
| trademark of X/Open Company Ltd. in the UK and other countries.</p> |
| </div> |
| <div class="paragraph"> |
| <p>OSF, OSF/1, OSF/Motif, Motif, and Open Software Foundation are trademarks of |
| the Open Software Foundation in the U.S. and other countries. |
| © 1990, 1991, 1992, 1993 Open Software Foundation, Inc.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The OSF documentation and the OSF software to which it relates are derived in |
| part from materials supplied by the following: © 1987, 1988, 1989 |
| Carnegie-Mellon University. © 1989, 1990, 1991 Digital Equipment |
| Corporation. © 1985, 1988, 1989, 1990 Encore Computer Corporation. © 1988 Free |
| Software Foundation, Inc. © 1987, 1988, 1989, 1990, 1991 Hewlett-Packard |
| Company. © 1985, 1987, 1988, 1989, 1990, 1991, 1992 International |
| Business Machines Corporation. © 1988, 1989 Massachusetts Institute of |
| Technology. © 1988, 1989, 1990 Mentat Inc. © 1988 Microsoft Corporation. |
| © 1987, 1988, 1989, 1990, 1991, |
| 1992 SecureWare, Inc. © 1990, 1991 Siemens Nixdorf Informations systeme |
| AG. © 1986, 1989, 1996, 1997 Sun Microsystems, Inc. © 1989, 1990, 1991 |
| Transarc Corporation.</p> |
| </div> |
| <div class="paragraph"> |
| <p>OSF software and documentation are based in part |
| on the Fourth Berkeley Software Distribution under license from The |
| Regents of the University of California. OSF acknowledges the following |
| individuals and institutions for their role in its development: Kenneth |
| C.R.C. Arnold, Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric |
| Computer Systems, Robert Elz. © 1980, 1981, 1982, 1983, 1985, 1986, |
| 1987, 1988, 1989 Regents of the University of California. OSF MAKES NO |
| WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED HEREIN, |
| INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY |
| AND FITNESS FOR A PARTICULAR PURPOSE. OSF shall not be liable for errors |
| contained herein or for incidental consequential damages in connection |
| with the furnishing, performance, or use of this material.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p><strong>Revision History</strong></p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Version</th> |
| <th class="tableblock halign-left valign-top">Date</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">2.2.0</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">TBD</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">2.1.0</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">May 1, 2017</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">2.0.1</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">July 7, 2016</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">2.0.0</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">June 6, 2016</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">1.3.0</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">January, 2016</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_about_this_document">1. About This Document</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This guide describes how to use the Trafodion Command Interface (trafci) on a client workstation to connect to and query a Trafodion database. |
| The trafci enables you to run SQL statements interactively or from script files.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_intended_audience">1.1. Intended Audience</h3> |
| <div class="paragraph"> |
| <p>This guide is intended for database administrators and support personnel who are maintaining and monitoring a Trafodion database.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_new_and_changed_information">1.2. New and Changed Information</h3> |
| <div class="paragraph"> |
| <p>This manual shows updated versions for Trafodion Release 2.4.0.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_notation_conventions">1.3. Notation Conventions</h3> |
| <div class="paragraph"> |
| <p>This list summarizes the notation conventions for syntax presentation in this manual.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>UPPERCASE LETTERS</p> |
| <div class="paragraph"> |
| <p>Uppercase letters indicate keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SELECT</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>lowercase letters</p> |
| <div class="paragraph"> |
| <p>Lowercase letters, regardless of font, indicate variable items that you supply. Items not enclosed in brackets are required.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">file-name</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>[ ] Brackets</p> |
| <div class="paragraph"> |
| <p>Brackets enclose optional syntax items.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">DATETIME [start-field TO] end-field</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A group of items enclosed in brackets is a list from which you can choose one item or none.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The items in the list can be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">DROP SCHEMA schema [CASCADE] |
| DROP SCHEMA schema [ CASCADE | RESTRICT ]</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>{ } Braces</p> |
| <div class="paragraph"> |
| <p>Braces enclose required syntax items.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">FROM { grantee [, grantee ] ... }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>A group of items enclosed in braces is a list from which you are required to choose one item.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">INTERVAL { start-field TO end-field } |
| { single-field } |
| INTERVAL { start-field TO end-field | single-field }</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>| Vertical Line</p> |
| <div class="paragraph"> |
| <p>A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">{expression | NULL}</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>… Ellipsis</p> |
| <div class="paragraph"> |
| <p>An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">ATTRIBUTE[S] attribute [, attribute] ... |
| {, sql-expression } ...</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">expression-n ...</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Punctuation</p> |
| <div class="paragraph"> |
| <p>Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">DAY (datetime-expression) |
| @script-file</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must type as shown.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">"{" module-name [, module-name] ... "}"</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Item Spacing</p> |
| <div class="paragraph"> |
| <p>Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">DAY (datetime-expression) DAY(datetime-expression)</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If there is no space between two items, spaces are not permitted. In this example, no spaces are permitted between the period and any other items:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">myfile.sh</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Line Spacing</p> |
| <div class="paragraph"> |
| <p>If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This spacing distinguishes items in a continuation line from items in a vertical list of selections.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">match-value [NOT] LIKE _pattern |
| [ESCAPE esc-char-expression]</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_comments_encouraged">1.4. Comments Encouraged</h3> |
| <div class="paragraph"> |
| <p>We encourage your comments concerning this document. We are committed to providing documentation that meets your |
| needs. Send any errors found, suggestions for improvement, or compliments to <a href="mailto:user@trafodion.apache.org">user@trafodion.apache.org</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_introduction">2. Introduction</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The Trafodion Command Interface (trafci) is a command-line interface that you download and install on a client workstation that has the |
| Trafodion JDBC Type 4 Driver installed. Operating systems that support the JDBC driver include Windows and Linux. The JDBC driver connects |
| trafci on a client workstation to a Trafodion database.</p> |
| </div> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/VST101.jpg" alt="trafci Connected to a Trafodion Database"></span></p> |
| </div> |
| <div class="paragraph"> |
| <p>trafci enables you to perform daily administrative and database management tasks by running SQL statements or other commands |
| interactively or from script files. You can also run trafci from a Perl or Python command line or from Perl or Python programs.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="install">3. Install and Configure</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_install_trafci">3.1. Install trafci</h3> |
| <div class="paragraph"> |
| <p>To install trafci on a client workstation, follow the procedures in the |
| <a href="http://trafodion.apache.org/docs/client_install/index.html">Trafodion Client Installation Guide</a>. |
| Ensure that you set up the Java Path per the instructions in that guide.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_test_trafci_launch">3.2. Test trafci Launch</h3> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Launch trafci and verify that you can connect to the database. For |
| instructions, see <a href="#launch_trafci">Launch trafci</a>.</p> |
| <div class="paragraph"> |
| <p>This window should appear:</p> |
| </div> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/launch02.jpg" alt="image"></span></p> |
| </div> |
| </li> |
| <li> |
| <p>If you cannot launch trafci or connect to the database, verify that:</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>The database platform is available and running, and the port number is correct for the database platform.</p> |
| </li> |
| <li> |
| <p>The Java path is set to the correct location. See <a href="#install_verify">Verify and Set the Java Path</a>.</p> |
| </li> |
| <li> |
| <p>You installed the trafci and JDBC software files correctly.</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ol> |
| </div> |
| <div class="paragraph"> |
| <p>See the <a href="http://trafodion.apache.org/docs/client_install/index.html">Trafodion Client Installation Guide</a>.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_launch_trafci">4. Launch trafci</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This chapter describes how to launch trafci from the Window or Linux environment of a client workstation. |
| For information about launching trafci from Perl or Python, see <a href="#perl_python">Run trafci from Perl or Python</a>.</p> |
| </div> |
| <div class="admonitionblock important"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-important" title="Important"></i> |
| </td> |
| <td class="content"> |
| Before launching trafci, make sure that you have set the Java path to the correct location. |
| See <a href="#install_verify">Verify and Set Java Path</a>. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="sect2"> |
| <h3 id="_launch_trafci_on_windows_workstation">4.1. Launch trafci on Windows Workstation</h3> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Find the Windows launch file, <code>trafci.cmd</code>, in the <code>bin</code> folder:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/winbin.jpg" alt="Navigate to bin folder" width="400" height="400"></span></p> |
| </div> |
| </li> |
| <li> |
| <p>Double-click the <code>trafci.cmd</code> file.</p> |
| <div class="paragraph"> |
| <p>trafci appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. |
| See <a href="#trafci_login">Log In to Database Platform</a>.</p> |
| </div> |
| </li> |
| </ol> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="sect3"> |
| <h4 id="trafci_shortcut">4.1.1. Create <code>trafci.cmd</code> Shortcut</h4> |
| <div class="paragraph"> |
| <p>To enable a user to launch trafci from a shortcut icon on the desktop:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Right-click the desktop and select <strong>New>Shortcut</strong>:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/shortct1.jpg" alt="Select trafci.cmd file" width="400" height="400"></span></p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </li> |
| <li> |
| <p>Type the location of <code>trafci.cmd</code> within double quotes (<code>"</code>) or click <strong>Browse</strong> to locate that file, and then click <strong>Next</strong>:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/shortct2.jpg" alt="Select shortcut from menu" width="400" height="400"></span></p> |
| </div> |
| <div class="paragraph"> |
| <p>For the locations of the installed trafci software files, |
| see the <a href="http://trafodion.apache.org/docs/client_install/index.html"><em>Trafodion Client Installation Guide</em></a>.</p> |
| </div> |
| </li> |
| <li> |
| <p>Type a name for the shortcut and click <strong>Finish</strong>:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/shortct3.jpg" alt="Name shortcut" width="400" height="400"></span></p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </li> |
| <li> |
| <p>If desired, specify optional launch parameters for the shortcut:</p> |
| <div class="olist loweralpha"> |
| <ol class="loweralpha" type="a"> |
| <li> |
| <p>Right-click the shortcut icon and select <strong>Properties</strong>:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/shortct4.jpg" alt="Select properties" width="400" height="400"></span></p> |
| </div> |
| </li> |
| <li> |
| <p>Select the <strong>Shortcut</strong> tab.</p> |
| </li> |
| <li> |
| <p>In the <strong>Target</strong> box, insert a space after <code>"…\Trafodion Command Interface\bin\trafci.cmd"</code> |
| and add the optional launch parameters:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/shortct5.jpg" alt="Add optional launch parameters" width="400" height="400"></span></p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#trafci_optional_params">Optional Launch Parameters</a>.</p> |
| </div> |
| </li> |
| <li> |
| <p>Click <strong>OK</strong>.</p> |
| </li> |
| </ol> |
| </div> |
| </li> |
| <li> |
| <p>To launch trafci, double-click the shortcut icon.</p> |
| <div class="paragraph"> |
| <p>trafci appears. If you did not set the optional launch parameters, trafci prompts you to enter the |
| host name or IP address of the database platform, your user name, and password. |
| See <a href="#trafci_login">Log In to Database Platform</a>.</p> |
| </div> |
| </li> |
| </ol> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_launch_trafci_on_linux_workstation">4.2. Launch trafci on Linux Workstation</h3> |
| <div class="paragraph"> |
| <p>In the terminal window, enter:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">./<trafci-installation-directory>/trafci/bin/trafci.sh</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><em><trafci-installation-directory></em> is the directory where you installed the trafci software files. |
| For more information, |
| see the <a href="http://trafodion.apache.org/docs/client_install/index.html"><em>Trafodion Client Installation Guide</em></a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_set_code_trafci_sh_code_path">4.2.1. Set <code>trafci.sh</code> PATH</h4> |
| <div class="paragraph"> |
| <p>To enable a user to launch trafci anywhere on the client workstation:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Open the user profile (<code>.profile</code> or <code>.bash_profile</code> for the Bash shell) in the |
| <code>$HOME</code> directory.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd $HOME |
| vi .profile</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>In the user profile, set the PATH environment variable to include the path of the <code>trafci.sh</code> file.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">export PATH=/<trafci-installation-directory>/trafci/bin/: ...</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><em>trafci-installation-directory</em> is the directory where you installed the trafci software files. |
| For more information, |
| see the <a href="http://trafodion.apache.org/docs/client_install/index.html"><em>Trafodion Client Installation Guide</em></a>. |
| Check that no space is after the colon (<code>:</code>) in the path.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| In the C shell, use the <code>setenv</code> command instead of <code>export</code>. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </li> |
| <li> |
| <p>To activate the changes, either log out and log in again or execute the user profile.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">. .profile</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </li> |
| <li> |
| <p>On the command line, execute the <code>trafci.sh</code> file to launch trafci:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">trafci.sh</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>trafci appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. |
| See <a href="#trafci_login">Log In to Database Platform</a>.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| To enable all users to launch trafci anywhere on the system, create a symbolic link to the |
| <code>trafci.sh</code> file in the <code>/usr/bin</code> or <code>/usr/local/bin</code> directory: |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">ln -s ./<trafci-installation-directory>/trafci/bin/trafci.sh /usr/bin/trafci.sh</code></pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="trafci_preset">4.2.2. Preset the Optional Launch Parameters</h4> |
| <div class="paragraph"> |
| <p>To preset the optional launch parameters for each session, use an <code>alias</code> in the shell command.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">alias trafci='trafci.sh -h 16.123.456.78:23400 -u user1 -p xxxxxx'</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>You can add the alias, trafci, to the user profile, or you can enter it at a command prompt. |
| For more information about the optional launch parameters, |
| see <a href="#trafci_optional_params">Use Optional Launch Parameters</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_login">4.3. Log In to Database Platform</h3> |
| <div class="sect3"> |
| <h4 id="_log_in_without_login_parameters">4.3.1. Log In Without Login Parameters</h4> |
| <div class="paragraph"> |
| <p>If you launch trafci and do not specify login parameters on the command line, follow these steps:</p> |
| </div> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>After you launch trafci, trafci shows the welcome banner and prompts you to enter the host name |
| or IP address of the database platform:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">Host Name/IP Address: _</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Enter a host name:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">host-name[.domain-name][:port-number]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If you do not specify the domain name, trafci uses the domain of the client workstation.</p> |
| </li> |
| <li> |
| <p>If you do not specify a port number, trafci uses the default port umber, which is <code>23400</code>.</p> |
| <div class="paragraph"> |
| <p>Or enter an IP address:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">IP-address[:port-number]</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p>Enter your directory-service (or LDAP) user name. User names are case-insensitive.</p> |
| </li> |
| <li> |
| <p>Enter your password. Passwords are case-sensitive.</p> |
| </li> |
| <li> |
| <p>After you finish logging in to the database platform, the SQL prompt appears:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">Connected to Trafodion |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| <div class="paragraph"> |
| <p>At the prompt, you can enter an SQL statement or an interface command. |
| For more information, see <a href="#run_interactive">Run Interactive Commands in trafci</a>.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| trafci allows you to reenter the login values, with a maximum of three retries, |
| before it closes the session. For more information, see <a href="#trafci_retry">Retry Login</a>. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="trafci_login_params">4.3.2. Use Login Parameters</h4> |
| <div class="paragraph"> |
| <p>To avoid entering a host name, user name, or password each time you launch trafci, use these login parameters:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>-h</code> or <code>-host</code></p> |
| </li> |
| <li> |
| <p><code>-u</code> or <code>-user</code></p> |
| </li> |
| <li> |
| <p><code>-p</code> or <code>-password</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example: Windows Login</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd <trafci-installation-directory>\Trafodion Command Interface\bin |
| |
| trafci.cmd -h 16.123.456.78:23400 -u user1 -p xxxxxx</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example: Linux Login</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd <trafci-installation-directory>/trafci/bin |
| |
| ./trafci.sh -h 16.123.456.78:23400 -u user1 -p xxxxxx</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>trafci launches and prompts you to enter an SQL statement or an interface command:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">Welcome to Trafodion Command Interface |
| Copyright(C) 2013–2105 Apache Software Foundation |
| |
| Connected to Trafodion |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information about the login parameters, see <a href="#trafci_optional_params">Use Optional Launch Parameters</a>.</p> |
| </div> |
| <div class="admonitionblock tip"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-tip" title="Tip"></i> |
| </td> |
| <td class="content"> |
| You can include these parameters in a shortcut to the <code>trafci.cmd</code> file or in a launch file for the |
| <code>trafci.sh</code> file. For more information, see <a href="#trafci_shortcut">Create <code>trafci.cmd</code> Shortcut</a> or |
| <a href="#trafci_preset">Preset the Optional Launch Parameters</a>, respectively. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_retry">4.4. Retry Login</h3> |
| <div class="paragraph"> |
| <p>trafci allows you to reenter the login values, with a maximum of three retries, before it closes the session.</p> |
| </div> |
| <div class="paragraph"> |
| <p>trafci applies the retry logic as follows:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If you specify an invalid host name, trafci prompts you to reenter the host name.</p> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">$ trafci –h dd # dd is invalid |
| |
| Welcome to Trafodion Command Interface |
| Copyright(C) 2013–2105 Apache Software |
| |
| Unknown Host: dd |
| |
| Host Name/IP Address: 172.16.1.1 |
| |
| User Name: user1 |
| Password: |
| |
| Connected to Trafodion SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If you specify an invalid user name or password, trafci prompts you to reenter the user name |
| and password.</p> |
| <div class="paragraph"> |
| <p>If you specify an invalid password, trafci prompts only for your user name and password. |
| After three unsuccessful retries, the session is terminated:</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">$ trafci –h 172.16.1.1 –u user1 –p x |
| |
| Welcome to Trafodion Command Interface |
| Copyright(C) 2013–2105 Apache Software |
| |
| **** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:23:44] |
| |
| User Name: user1 |
| Password: |
| |
| **** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:25:28] |
| |
| User Name: user1 |
| Password: |
| |
| **** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:26:36] |
| |
| Press any key to close this session</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If all the login parameters that you specify are invalid, trafci prompts you to enter the host |
| name. When you enter a valid host name or IP address, trafci prompts you to enter a user name and password.</p> |
| </li> |
| <li> |
| <p>The retry logic applies to the CONNECT and RECONNECT commands. For the RECONNECT command, the retry logic |
| applies only when no prior connection has been established (<code>-noconnect</code>).</p> |
| <div class="paragraph"> |
| <p>For example, if you specify the CONNECT command with a valid user name and host name, then |
| trafci prompts for the user name and password only.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> connect user1/xxx@172.16.1.1 |
| |
| org.trafodion.jdbc.t4.TrafT4Exception: **** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:35:15] |
| |
| User Name: user1 |
| Password: abc |
| |
| Connected to Trafodion SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>trafci does not prompt you to reenter the login values in these cases:</p> |
| </li> |
| <li> |
| <p>When you include the <code>-q</code> or <code>-version</code> parameter on the command line. |
| (The <code>-s</code> parameter permits login retries.)</p> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>For a session started using redirected or piped input.</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>In these cases, trafci returns an error message and closes the session. You must re-launch the trafci session |
| to connect to the Trafodion database.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_option_params">4.5. Optional Launch Parameters</h3> |
| <div class="paragraph"> |
| <p>To customize how you launch and log in to trafci, use the optional parameters described in the table below on the command line:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">trafci{.sh | .cmd} [optional-parameter]...</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>optional-parameter</em></code></p> |
| <div class="paragraph"> |
| <p>is one of the launch or login parameters. For details, see the following table.</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 50%;"> |
| <col style="width: 50%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Launch or Login Parameter</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{-h | -host} host-name[:port-number]</code><br> |
| <code>{-h | -host} IP-address[:port-number]</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the host name or IP address of the database |
| platform to which you want the client to connect. |
| The <em>host-name</em> should include the domain name of the database platform if it is different from the domain |
| of the client workstation. If you do not specify a port number, trafci uses the default port number, which |
| is <code>23400</code>.<br> |
| <br> |
| See <a href="#trafici_login_parameters">Use Login Parameters</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{-u | -user} <em>username</em></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the user name for logging in to the database platform. |
| The <em>username</em> is case-insensitive.<br> |
| <br> |
| For an example, see <a href="#trafici_login_parameters">Use Login Parameters</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{-r | -role} <em>role-name</em></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Reserved for future use.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{-p | -password} <em>password</em></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the password of the user for logging in to the database |
| platform. <em>password</em> is case-sensitive.<br> |
| <br> |
| For an example, see <a href="#trafici_login_parameters">Use Login Parameters</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{-q | -sql} "<em>command</em>"</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies that an SQL statement or an interface command be run when |
| launching trafci. You cannot specify this parameter at the same time as |
| the -s or -script parameter.<br> |
| <br> |
| For more information, see <a href="#trafci_run_command">Run Command When Launching trafci</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>{-s | -script} <em>script-file-name</em></code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies that a script file be run when launching trafci in interactive |
| mode. You cannot specify this parameter at the same time as the -q or |
| -sql parameter.<br> |
| <br> |
| For more information, see <a href="#trafci_run_script">Run Script When Launching trafci</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-noconnect</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Launches an trafci session without connecting to the database.<br> |
| <br> |
| For more information, see <a href="#trafci_noconnect">Launch trafci Without Connecting to the Database</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-version</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the build version of trafci and the Trafodion JDBC Type 4 |
| Driver. Upon completion of the display, the client exits.<br> |
| <br> |
| If any other parameters are included with the <code>-version</code> parameter, they are ignored.<br> |
| <br> |
| For more information, see <a href="#trafci_with_version">Run trafci With <code>-version</code></a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-help</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays a list of accepted arguments with descriptions and then exits.<br> |
| <br> |
| For more information, see <a href="#trafci_with_version">Run trafci With <code>-version</code></a>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_run_command">4.6. Run Command When Launching trafci</h3> |
| <div class="paragraph"> |
| <p>To execute an SQL statement or an interface command when launching trafci, use the <code>-q</code> or <code>-sql</code> |
| command-line parameter. This parameter enables you to run a single command on the command line |
| without having to enter commands in trafci.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| You cannot specify this parameter at the same time as the <code>-s</code> or <code>-script</code> parameter. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>When using <code>-q</code> or <code>-sql</code>, you must enclose the command in double quotes (<code>"</code>). The SQL terminator |
| is not required at the end of an SQL statement and is disallowed after an interface command.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Although you can run any of the interface commands with <code>-q</code> or <code>-sql</code>, the |
| <code>@</code>, <code>OBEY</code>, and <code>PRUN</code> commands are the most useful.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Use <code>-q</code> or <code>-sql</code> with the <code>CREATE SCHEMA</code> statement to create a schema when launching trafci:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>On Windows, in the <strong>Command Prompt</strong> window, enter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd _trafci-installation-directory_\Trafodion Command Interface\bin |
| trafci.cmd -q "create schema persnl"</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>On Linux or UNIX, in the terminal window, enter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd _trafci-installation-directory_/trafci/bin |
| ./trafci.sh -q "create schema persnl"</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>After you enter the SQL statement, trafci launches and prompts you to log in by default |
| (if you did not specify <code>-h</code>, <code>-u</code>, and <code>-p</code> on the command line), runs the SQL statement, |
| and then returns to the command prompt:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">Host Name/IP Address: 16.123.456.78:23400 User Name: user1 |
| |
| Password: |
| |
| --- SQL operation complete. |
| |
| C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Use <code>-q</code> or <code>-sql</code> with the <code>PRUN</code> command to run multiple script files simultaneously from the command line:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>On Windows, in the <strong>Command Prompt</strong> window, enter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd <trafci-installation-directory>\Trafodion Command Interface\bin |
| trafci.cmd -q "prun"</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>On Linux, in the terminal window, enter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">cd <trafci-installation-directory>/trafci/bin |
| ./trafci.sh -q "prun"</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>After you enter the interface command, trafci launches and prompts you to log in by default (if you did not specify |
| <code>-h</code>, <code>-u</code>, and <code>-p</code> on the command line), and runs the command.\ The parallel run (<code>PRUN</code>) operation prompts you to |
| enter settings and then executes the script files. At the end of the <code>PRUN</code> operation, trafci returns to the command prompt.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information about the <code>PRUN</code> operation, see <a href="#trafci_prun"><code>PRUN</code> Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_run_script">4.7. Run Script When Launching trafci</h3> |
| <div class="paragraph"> |
| <p>To run a script file when launching trafci, use the <code>-s</code> or <code>-script</code> command-line parameter.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| You cannot specify this parameter at the same time as the <code>-q</code> or <code>-sql</code> parameter. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div |
