| <!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 class="paragraph"> |
| <p>After you launch trafci with <code>-s</code> or <code>-script</code>, trafci executes the script file in interactive mode. |
| trafci remains open until you enter the <code>EXIT</code>, <code>QUIT</code>, or <code>DISCONNECT</code> command. To quit the interface |
| immediately after executing a script file, include the <code>EXIT</code>, <code>QUIT</code>, or <code>DISCONNECT</code> command |
| at the end of the script file.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>You can create a script file that contains <code>SET</code> commands that customize a session when you launch trafci:</p> |
| </div> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/launchs1.jpg" alt="image"></span></p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, <a href="#script_create">Create a Script File</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></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 -s settings.txt</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Specify the full path of the script file if it is outside the directory of <code>trafci.cmd</code>.</p> |
| </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 -s settings.txt</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Specify the full path of the script file if it is outside the directory of <code>trafci.sh</code>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>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 commands in the script file:</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 |
| |
| Host Name/IP Address: 16.123.456.78:23400 User Name: user1 |
| Password: |
| Connected to Trafodion |
| |
| SQL>SET IDLETIMEOUT 0 |
| |
| SQL>SET SQLPROMPT * |
| |
| *SET TIME ON |
| |
| 14:14:57 *SET TIMING ON |
| |
| 2:14:57 PM *SET SQLTERMINATOR .</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_noconnect">4.8. Launch trafci Without Connecting to the Database</h3> |
| <div class="paragraph"> |
| <p>To start trafci without connecting to a Trafodion database, use the <code>-noconnect option</code>. |
| See <a href="#cmd_disconnect"><code>DISCONNECT</code> command</a> for a list of interface commands that can |
| be run without a connection.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></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 -noconnect</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 -noconnect</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_with_version">4.9. Run trafci With <code>-version</code></h3> |
| <div class="paragraph"> |
| <p>To display the build version of trafci and the Trafodion JDBC Type 4 Driver, use the <code>-version</code> |
| option. If other parameters are included with the <code>-version</code> parameter, they are ignored.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></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 -version</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 -version</code></pre> |
| </div> |
| </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 |
| |
| Trafodion JDBC Type 4 Driver : Traf_JDBC_Type4_Build_40646 Trafodion |
| Command Interface : trafci_Build_40646</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_help">4.10. Run trafci With -help</h3> |
| <div class="paragraph"> |
| <p>To display a list of acceptable list of parameters, including proper usage information, use the |
| <code>-help</code> option. After displaying this information the application exits.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></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 -help</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 -help</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="trafci_quit">4.11. Exit trafci</h3> |
| <div class="paragraph"> |
| <p>To exit trafci, enter one of these commands at a prompt:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>EXIT</code></p> |
| </li> |
| <li> |
| <p><code>QUIT</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> QUIT</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>These commands are not case-sensitive and do not require a terminator before you press <strong>Enter</strong>. |
| After you enter one of these commands, trafci immediately quits running and disappears from the screen.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_run_commands_interactively">5. Run Commands Interactively</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>After launching trafci, you can run SQL statements and interface commands in the command-line interface.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_user_interface">5.1. User Interface</h3> |
| <div class="sect3"> |
| <h4 id="_product_banner">5.1.1. Product Banner</h4> |
| <div class="paragraph"> |
| <p>After you launch trafci and connect to the database platform, the product banner appears in the |
| command-line interface:</p> |
| </div> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/launch02.jpg" alt="Product banner"></span></p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_interface_prompt">5.1.2. Interface Prompt</h4> |
| <div class="paragraph"> |
| <p>The standard prompt is <code>SQL></code>. You can change the prompt, <code>SQL></code>, to something else by using the |
| <code>SET SQLPROMPT</code> or <code>SET PROMPT</code> command. For more information, |
| <a href="#interactive_customize_prompt">Customize the Standard Prompt</a>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_break_the_command_line">5.1.3. Break the Command Line</h4> |
| <div class="paragraph"> |
| <p>You cannot break an interface command over multiple lines. Each interface command must be entered |
| on one line. If you accidentally break an interface command across more than one line, enter the |
| SQL terminator and then reenter the command on one line.</p> |
| </div> |
| <div class="paragraph"> |
| <p>You can continue any SQL statement over multiple lines, breaking that statement at any point except |
| within a word, a numeric literal, or a multi-character operator (for example, <code><=</code>). To break a string |
| literal in a DML statement, use a concatenation operator (<code>||</code>). For more information, see the |
| concatenation operator in the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To terminate an SQL statement that spans multiple lines, use the SQL terminator for the session. |
| You can also include several SQL statements on the same command line provided that each one is |
| terminated by the SQL terminator. For more information, see |
| <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_case_sensitivity">5.1.4. Case Sensitivity</h4> |
| <div class="paragraph"> |
| <p>In the command-line interface, you can enter SQL statements and interface commands in uppercase, |
| lowercase, or mixed-case characters. All parts of statements and commands are case-insensitive except |
| for parts that you enclose in single-quotes (<code>'</code>) or double-quotes (<code>"</code>).</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_interface_commands">5.2. Interface Commands</h3> |
| <div class="paragraph"> |
| <p>The interface commands allow you to customize trafci (for example, by using <code>SET</code> commands) or |
| return information about the interface settings or database objects (for example, |
| by using <code>SHOW commands</code>).</p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information about the interface commands, see <a href="#commands">Commands</a>.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| Each interface command must be entered on one line. If you accidentally break an interface |
| command across more than one line, enter the SQL terminator and then reenter the command on one line. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_show_session_attributes">5.2.1. Show Session Attributes</h4> |
| <div class="paragraph"> |
| <p>To display the attributes and settings of the current trafci session, use the <code>ENV</code>, <code>SHOW SESSION</code>, |
| or <code>SESSION</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SESSION command displays the session attributes:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SESSION |
| |
| COLSEP " " |
| HISTOPT DEFAULT [No expansion of script files] |
| IDLETIMEOUT 0 min(s) [Never Expires] |
| LIST_COUNT 0 [All Rows] |
| LOG FILE c:\session.txt |
| LOG OPTIONS APPEND,CMDTEXT ON |
| MARKUP RAW |
| PROMPT SQL> |
| SCHEMA SEABASE |
| SERVER sqws135.houston.host.com:23400 |
| SQLTERMINATOR ; |
| STATISTICS OFF |
| TIME OFF |
| TIMING OFF |
| USER user1 |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#cmd_env">ENV Command</a> <a href="#cmd_show_session">SHOW SESSION Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="interactive_idle_timeout">5.2.2. Set and Show Session Idle Timeout Value</h4> |
| <div class="paragraph"> |
| <p>The idle timeout value of a session determines when the session expires after a period of inactivity. |
| To set the idle timeout value of a session, enter the <code>SET IDLETIMEOUT</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SET IDLETIMEOUT 0</code> command sets the idle timeout to an infinite amount of time so that the |
| session never expires:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET IDLETIMEOUT 0 |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To show the idle timeout value that is in effect for the session, enter the <code>SHOW IDLETIMEOUT</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SHOW IDLETIMEOUT</code> command displays an idle timeout of zero minutes, which means that the session |
| never expires:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW IDLETIMEOUT |
| |
| IDLETIMEOUT 0 min(s) [Never Expires] |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_set_idletimeout">SET IDLETIMEOUT Command</a> and the |
| <<cmd_show_idletimeout, SET IDLETIMEOUT Command>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="interactive_customize_prompt">5.2.3. Customize the Standard Prompt</h4> |
| <div class="paragraph"> |
| <p>To change the standard prompt in the command-line interface, use one or both of these commands:</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="_set_prompt_command">SET PROMPT Command</h5> |
| <div class="paragraph"> |
| <p>The <code>SET PROMPT</code> command changes the default prompt to a specified character or string.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SET PROMPT</code> command changes the prompt to the current user (<code>user1</code>) and <code>ENTER></code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL>set prompt "%USER ENTER>" |
| |
| user1 ENTER></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#cmd_set_prompt">SET PROMPT Command</a>.</p> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="_set_time_command">SET TIME Command</h5> |
| <div class="paragraph"> |
| <p>The <code>SET TIME ON</code> command causes the current time of the client workstation to be |
| displayed in the prompt:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL ENTER> SET TIME ON |
| |
| 20:32:26 SQL ENTER></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>SET TIME OFF</code> command removes the current time from the prompt:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">20:32:26 SQL ENTER> SET TIME OFF |
| |
| SQL ENTER></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_set_time">SET TIME Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="interactive_set_show_terminator">5.2.4. Set and Show the SQL Terminator</h4> |
| <div class="paragraph"> |
| <p>The SQL terminator symbolizes the end of an SQL statement. By default, the SQL terminator |
| is a semicolon (<code>;</code>).</p> |
| </div> |
| <div class="paragraph"> |
| <p>To change the SQL terminator, enter the <code>SET SQLTERMINATOR</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SET SQLTERMINATOR command sets the SQL terminator to a period (<code>.</code>):</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLTERMINATOR . |
| SQL> INSERT INTO sales.custlist |
| +> (SELECT * FROM invent.supplier |
| +> WHERE suppnum=8). |
| |
| --- 1 row(s) inserted. |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To show the SQL terminator that is in effect for the session, enter the <code>SHOW SQLTERMINATOR</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SHOW SQLTERMINATOR</code> command displays SQLTERMINATOR <code>.</code>, where the period (<code>.</code>) is the |
| SQL terminator for the session:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW SQLTERMINATOR |
| SQLTERMINATOR . |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_set_sqlterminator">SET SQLTERMINATOR Command</a> and |
| the <a href="#cmd_show_sqlterminator">SHOW SQLTERMINATOR Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="interactive_display_elapsed_time">5.2.5. Display the Elapsed Time</h4> |
| <div class="paragraph"> |
| <p>By default, trafci does not display the elapsed time of an SQL statement after the statement |
| executes. To display the elapsed time after each SQL statement executes, enter the <code>SET TIMING ON</code> |
| command:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING ON |
| SQL> SELECT suppname, street, city, state, postcode |
| +> FROM invent.supplier |
| +> WHERE suppnum=3; |
| |
| SUPPNAME STREET CITY STATE POSTCODE |
| ----------------- -------------------- -------------- ------------ ---------- |
| HIGH DENSITY INC 7600 EMERSON NEW YORK NEW YORK 10230 |
| |
| --- 1 row(s) selected. Elapsed :00:00:00.111 SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To prevent the elapsed time from being displayed after each SQL statement executes, |
| enter the <code>SET TIMING OFF</code> command:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING OFF |
| SQL> / |
| |
| SUPPNAME STREET CITY STATE POSTCODE |
| ----------------- -------------------- -------------- ------------ ---------- |
| HIGH DENSITY INC 7600 EMERSON NEW YORK NEW YORK 10230 |
| |
| --- 1 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_set_timing">SET TIMING Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="interactive_set_show_current_schema">5.2.6. Set and Show the Current Schema</h4> |
| <div class="paragraph"> |
| <p>By default, the schema of the session is <code>USR</code>. The SQL statement, <code>SET SCHEMA</code>, |
| allows you to set the schema for the trafci session.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SET SCHEMA</code> statement changes the default schema to <code>PERSNL</code> for the session:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SCHEMA persnl; |
| |
| --- SQL operation complete. |
| |
| SQL> DELETE FROM employee |
| +> WHERE first_name='TIM' AND |
| +> last_name='WALKER'; |
| |
| --- 1 row(s) deleted. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The schema that you specify with <code>SET SCHEMA</code> remains in effect until the end of the session |
| or until you execute another <code>SET SCHEMA</code> statement.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you execute this statement in a script file, it affects not only the SQL statements in the |
| script file but all subsequent SQL statements that are run in the current session. If you set |
| the schema in a script file, reset the default schema for the session at the end of the script |
| file.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information about the SET SCHEMA statement, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>SHOW SCHEMA</code> command displays the current schema for the session.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SHOW SCHEMA</code> command displays <code>SCHEMA PERSNL</code>, where <code>PERSNL</code> is the name of the current |
| schema for the session:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW SCHEMA SCHEMA persnl |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, <a href="#cmd_show_schema">SHOW SCHEMA Command</a>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_limit_query_result_set">5.2.7. Limit Query Result Set</h4> |
| <div class="paragraph"> |
| <p>To set the maximum number of rows to be returned by <code>SELECT</code> statements that are executed |
| in the session, enter the <code>SET LIST_COUNT</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SET LIST_COUNT</code> command limits the result set of queries to 20 rows:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET LIST_COUNT 20</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To show the limit that is in effect for the session, enter the <code>SHOW LIST_COUNT</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SHOW LIST_COUNT</code> command shows that the number of rows returned by <code>SELECT</code> statements |
| is unlimited:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW LIST_COUNT |
| |
| LISTCOUNT 0 [All Rows]</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_set_list_count">SET LIST_COUNT Command</a> and |
| <a href="#cmd_show_list_count">SHOW LIST_COUNT Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="interactive_history">5.2.8. Display Executed Commands</h4> |
| <div class="paragraph"> |
| <p>To display commands that were recently executed in the trafci session, enter the |
| <code>HISTORY</code> command. The <code>HISTORY</code> command associates each command with a number that |
| you can use to re-execute or edit the command with the <code>FC</code> command. See |
| <a href="#edit_reexecute_command">Edit and Reexecute a Command</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>HISTORY</code> command displays a maximum of 100 commands that were entered in the session:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HISTORY |
| |
| 1> SET IDLETIMEOUT 0 |
| 2> SET SCHEMA persnl; |
| 3> SELECT * FROM project; |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To save the session history in a user-specified file, enter the <code>SAVEHIST</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SAVEHIST</code> command saves the session history in a file named <code>history.txt</code> in the |
| local directory where you are running trafci:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SAVEHIST history.txt</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_history">HISTORY Command</a> and |
| the <a href="#cmd_savehist">SAVEHIST Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="edit_reexecute_command">5.2.9. Edit and Reexecute a Command</h4> |
| <div class="paragraph"> |
| <p>To edit and reexecute a command in the history buffer of an trafci session, enter the <code>FC</code> command. |
| To display the commands in the history buffer, use the <code>HISTORY</code> command. See |
| <a href="#interactive_history">Display Executed Commands</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <strong>FC</strong> command and its delete (<code>D</code>) editing command correct a <code>SELECT</code> statement that was entered incorrectly:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> FC |
| |
| SQL> SELECCT FROM employee; |
| .... d |
| SQL> SELECT FROM employee;</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Pressing Enter executes the corrected <code>SELECT</code> statement. For more information, see the |
| <a href="#cmd_fc">FC Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_clear_the_interface_window">5.2.10. Clear the Interface Window</h4> |
| <div class="paragraph"> |
| <p>After entering commands in trafci, you can clear the interface window by using the <code>CLEAR</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>CLEAR</code> command clears the interface window so that only the prompt appears at the top of the |
| window:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> CLEAR</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_clear">CLEAR Command</a>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_obtain_help">5.2.11. Obtain Help</h4> |
| <div class="paragraph"> |
| <p>To display help text for an interface command that is supported in trafci, enter the <code>HELP</code> command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>HELP</code> command displays syntax and examples of the <code>FC</code> command:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HELP FC</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_help">HELP Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_run_sql_statements">5.3. Run SQL Statements</h3> |
| <div class="paragraph"> |
| <p>In trafci, you can run SQL statements interactively. trafci supports all the SQL statements, |
| SQL utilities, and other SQL-related commands that the Trafodion database engine supports. |
| For more information about those SQL statements, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To run SQL statements from script files in trafci, see <a href="#run_scripts">Run Scripts</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_execute_an_sql_statement">5.3.1. Execute an SQL Statement</h4> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>You can query the <code>EMPLOYEE</code> table and return an employee’s salary by executing this <code>SELECT</code> statement |
| in trafci:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT salary |
| +> FROM persnl.employee |
| +> WHERE jobcode=100; |
| |
| SALARY |
| ---------- |
| 175500.00 |
| 137000.10 |
| 139400.00 |
| 138000.40 |
| 75000.00 |
| 90000.00 |
| 118000.00 |
| 80000.00 |
| 70000.00 |
| 90000.00 |
| 56000.00 |
| |
| --- 11 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If the SQL statement executes successfully, trafci returns a message indicating that the SQL |
| operation was successful, followed by the standard prompt. If a problem occurs during the |
| execution of the SQL statement, trafci returns an error message.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_repeat_an_sql_statement">5.3.2. Repeat an SQL Statement</h4> |
| <div class="paragraph"> |
| <p>To run a previously executed SQL statement, use the <code>/</code>, <code>RUN</code>, or <code>REPEAT</code> command.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> / |
| |
| SALARY |
| ---------- |
| 175500.00 |
| 137000.10 |
| 139400.00 |
| 138000.40 |
| 75000.00 |
| 90000.00 |
| 118000.00 |
| 80000.00 |
| 70000.00 |
| 90000.00 |
| 56000.00 |
| |
| --- 11 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_slash">/ Command</a>, |
| <a href="#cmd_run">RUN Command</a>, or <a href="#cmd_repeat">REPEAT Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_prepare_and_execute_sql_statements">5.3.3. Prepare and Execute SQL Statements</h4> |
| <div class="paragraph"> |
| <p>You can prepare, or compile, an SQL statement by using the <code>PREPARE</code> statement and |
| later execute the prepared SQL statement by using the <code>EXECUTE</code> statement.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="interactive_prepare_sql_statement">Prepare a SQL Statement</h5> |
| <div class="paragraph"> |
| <p>Use the PREPARE statement to compile an SQL statement for later execution with the |
| EXECUTE statement. You can also use the PREPARE statement to check the syntax of |
| an SQL statement without executing the statement.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This PREPARE statement compiles a SELECT statement named empsal and detects a syntax error:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> PREPARE empsal FROM |
| +> SELECT salary FROM employee |
| +> WHERE jobcode = 100; |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>You can then correct the syntax of the SQL statement and prepare it again:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> PREPARE empsal FROM |
| +> SELECT salary FROM persnl.employee |
| +> WHERE jobcode = 100; |
| |
| --- SQL command prepared.</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To specify a parameter to be supplied later, either in a <code>SET PARAM</code> statement or |
| in the <code>USING</code> clause of an <code>EXECUTE</code> statement, use one of these types of parameters |
| in the SQL statement:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Named parameter, which is represented by <code>?<em>param-name</em></code></p> |
| </li> |
| <li> |
| <p>Unnamed parameter, which is represented by a question mark (<code>?</code>) character</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This prepared <code>SELECT</code> statement specifies unnamed parameters for salary and job code:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> PREPARE findemp FROM |
| +> SELECT FROM persnl.employee |
| +> WHERE salary > ? AND jobcode = ?; |
| |
| --- SQL command prepared.</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This PREPARE statement prepares another <code>SELECT</code> statement named <code>empcom</code>, which has one |
| named parameter, <code>?<em>dn</em></code>, for the department number, which appears twice in the statement:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> PREPARE empcom FROM |
| +> SELECT first_name, last_name, deptnum |
| +> FROM persnl.employee |
| +> WHERE deptnum <> ?dn AND salary <= |
| +> (SELECT AVG(salary) |
| +> FROM persnl.employee |
| +> where deptnum = ?dn); |
| |
| --- SQL command prepared.</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For the syntax of the PREPARE statement, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="interactive_set_parameters">Setting Parameters</h5> |
| <div class="paragraph"> |
| <p>In an trafci session, you can set a parameter of an SQL statement (either prepared or not) |
| by using the SET PARAM command.</p> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| The parameter name is case-sensitive. If you specify it in lowercase in the |
| SET PARAM command, you must specify it in lowercase in other statements, such as |
| DML statements or EXECUTE. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SET PARAM command sets a value for the parameter named ?sal, which you can apply |
| to one of the unnamed parameters in the prepared findemp statement or to a named parameter |
| with an identical name in an SQL statement:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?sal 40000.00</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SELECT</code> statement uses sal as a named parameter:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT last_name |
| +> FROM persnl.employee |
| +> WHERE salary = ?sal;</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SET PARAM</code> command sets a value for the parameter named <code>dn</code>, which you can apply |
| to the named parameter, <code>?dn</code>, in the prepared <code>empcom</code> statement or to a named parameter |
| with an identical name in an SQL statement:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?dn 1500</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For the syntax of the <code>SET PARAM</code> command, see the <a href="#cmd_set_param">SET PARAM Command</a>.</p> |
| </div> |
| <div id="interactive_display_session_parameters" class="paragraph"> |
| <p>To determine what parameters you have set in the current session, use the SHOW PARAM command.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SHOW PARAM command displays the recent SET PARAM settings:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW PARAM dn 1500 |
| sal 40000.00 |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For the syntax of the <code>SHOW PARAM</code> command, <a href="#cmd_show_param">SHOW PARAM Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect4"> |
| <h5 id="interactive_reset_parameters">Reset the Parameters</h5> |
| <div class="paragraph"> |
| <p>To change the value of a parameter, specify the name of the parameter in the RESET PARAM |
| command and then use the SET PARAM command to change the setting.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>Suppose that you want to change the salary parameter to 80000.00:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> RESET PARAM ?sal |
| SQL> SET PARAM ?sal 80000.00 |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Entering the <code>RESET PARAM</code> command without specifying a parameter name clears all |
| parameter settings in the session.</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">SQL> RESET PARAM |
| SQL> SHOW PARAM |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To use the parameters that you had set before, you must reenter them in the session:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?dn 1500 |
| SQL> SET PARAM ?sal 80000.00 |
| SQL> SHOW PARAM dn 1500 |
| |
| sal 80000.00 |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For the syntax of the <code>RESET PARAM</code> command, see the <a href="#cmd_reset_param">RESET PARAM Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_execute_a_prepared_sql_statement">5.3.4. Execute a Prepared SQL Statement</h4> |
| <div class="paragraph"> |
| <p>To execute a prepared SQL statement, use the <code>EXECUTE</code> statement.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>EXECUTE</code> statement executes the prepared <code>empsal</code> statement, which does not have any parameters:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> EXECUTE empsal; |
| |
| SALARY |
| ---------- |
| 137000.10 |
| 90000.00 |
| 75000.00 |
| 138000.40 |
| 56000.00 |
| 136000.00 |
| 80000.00 |
| 70000.00 |
| 175500.00 |
| 90000.00 |
| 118000.00 |
| |
| --- 11 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>This <code>EXECUTE</code> statement executes the prepared empcom statement, which has one named parameter, |
| <code>?dn</code>, which was set by <code>SET PARAM</code> for the department number:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL>EXECUTE empcom; |
| |
| FIRST_NAME LAST_NAME DEPTNUM |
| --------------- -------------------- ------- |
| ALAN TERRY 3000 |
| DAVID TERRY 2000 |
| PETE WELLINGTON 3100 |
| JOHN CHOU 3500 |
| MANFRED CONRAD 4000 |
| DINAH CLARK 9000 |
| DAVE FISHER 3200 |
| GEORGE FRENCHMAN 4000 |
| KARL HELMSTED 4000 |
| JOHN JONES 4000 |
| JOHN HUGHES 3200 |
| WALTER LANCASTER 4000 |
| MARLENE BONNY 4000 |
| BILL WINN 2000 |
| MIRIAM KING 2500 |
| GINNY FOSTER 3300</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">MARIA JOSEF 4000 |
| HERB ALBERT 3300 |
| RICHARD BARTON 1000 |
| XAVIER SEDLEMEYER 3300 |
| DONALD TAYLOR 3100 |
| LARRY CLARK 1000 |
| JIM HERMAN 3000 |
| GEORGE STRICKER 3100 |
| OTTO SCHNABL 3200 |
| TIM WALKER 3000 |
| TED MCDONALD 2000 |
| PETER SMITH 3300 |
| MARK FOLEY 4000 |
| HEIDI WEIGL 3200 |
| ROCKY LEWIS 2000 |
| SUE CRAMER 1000 |
| MARTIN SCHAEFFER 3200 |
| HERBERT KARAJAN 3200 |
| JESSICA CRINER 3500 |
| |
| --- 35 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>This <code>EXECUTE</code> statement executes the prepared findemp statement, which has two |
| unnamed parameters: <code>?sal</code>, which was set by <code>SET PARAM</code> for the salary, and a |
| parameter that was not set in advance for the job code:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> EXECUTE findemp USING ?sal, 100; |
| |
| EMP_NUM FIRST_NAME LAST_NAME DEPTNUM JOBCODE SALARY |
| ------- --------------- -------------------- ------- ------- --------- |
| 213 ROBERT WHITE 1500 100 90000.00 |
| 23 JERRY HOWARD 1000 100 137000.10 |
| 1 ROGER GREEN 9000 100 175500.00 |
| 29 JANE RAYMOND 3000 100 136000.00 |
| 32 THOMAS RUDLOFF 2000 100 138000.40 |
| 43 PAUL WINTER 3100 100 90000.00 |
| 65 RACHEL MCKAY 4000 100 118000.00 |
| |
| --- 7 row(s) selected. |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For the syntax of the EXECUTE statement, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="interactive_log_output">5.4. Log Output</h3> |
| <div class="paragraph"> |
| <p>To log an trafci session, use the <code>SPOOL</code> or <code>LOG</code> command. The <code>SPOOL</code> and <code>LOG</code> commands |
| record into a log file the commands that you enter in the command-line interface and the |
| output of those commands.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_start_the_logging_process">5.4.1. Start the Logging Process</h4> |
| <div class="paragraph"> |
| <p>To start logging, enter one of these commands:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>SPOOL ON</code> or <code>LOG ON</code></p> |
| </li> |
| <li> |
| <p><code>SPOOL <em>log-file</em></code> or <code>LOG <em>log-file</em></code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see the <a href="#cmd_log">LOG Command</a> and |
| the <a href="#cmd_spool">SPOOL Command</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="sect4"> |
| <h5 id="__code_spool_on_code_or_code_log_on_code_command"><code>SPOOL ON</code> or <code>LOG ON</code> Command</h5> |
| <div class="paragraph"> |
| <p>The <code>SPOOL ON</code> or <code>LOG ON</code> command logs information about a session in the <code>sqlspool.lst</code> |
| file, which trafci stores in the bin directory:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>On Windows:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text"><trafci-installation-directory>\Trafodion Command Interface\bin\sqlspool.lst</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><code><em>trafci-installation-directory</em></code> is the directory where you installed the |
| trafci software files.</p> |
| </div> |
| </li> |
| <li> |
| <p>On Linux:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text"><trafci-installation-directory>/trafci/bin/sqlspool.lst</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><code><em>trafci-installation-directory</em></code> is the directory where you installed |
| the trafci software files.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SPOOL ON command starts logging the session in the <code>sqlspool.lst</code> file:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL ON</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="__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</h4> |
| <div class="paragraph"> |
| <p>The <code>SPOOL <em>log-file</em></code> and <code>LOG <em>log-file</em></code> commands record information about a session |
| in a log file that you specify. If you specify a directory for the log file, the |
| directory must exist as specified. Otherwise, an error occurs when you try to run the |
| <code>SPOOL</code> or <code>LOG</code> command. If you do not specify a directory for the log file, trafci uses the |
| <code>bin</code> directory.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>SPOOL <em>log-file</em></code> command starts logging the session in the <code>persnl_updates.log</code> file in |
| the <code>C:\log directory</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL C:\log\persnl_updates.log</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="sect4"> |
| <h5 id="_using_the_code_clear_code_option">Using the <code>CLEAR</code> Option</h5> |
| <div class="paragraph"> |
| <p>The CLEAR option clears the contents of an existing log file before logging new information to |
| the file. If you omit CLEAR, trafci appends new information to existing information in the log file.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SPOOL <em>log-file</em> CLEAR command clears existing information from the specified log file and |
| starts logging the session in the log file:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL C:\log\persnl_updates.log clear</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="_log_concurrent_the_trafci_sessions">Log Concurrent the trafci Sessions</h5> |
| <div class="paragraph"> |
| <p>If you plan to run two or more trafci sessions concurrently on the same workstation, use the |
| <code>SPOOL <em>log-file</em></code> or <code>LOG <em>log-file</em></code> command and specify a unique name for each log file. |
| Otherwise, each session writes information to the same log file, making it difficult to determine |
| which information belongs to each session.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_stopping_the_logging_process">5.4.3. Stopping the Logging Process</h4> |
| <div class="paragraph"> |
| <p>To stop logging, enter one of these commands:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>SPOOL OFF</code></p> |
| </li> |
| <li> |
| <p><code>LOG OFF</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This SPOOL OFF command stops logging in an trafci session:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL OFF</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_view_the_contents_of_a_log_file">5.4.4. View the Contents of a Log File</h4> |
| <div class="paragraph"> |
| <p>The log file is an ASCII text file that contains all the lines in trafci from the time you start |
| logging to the time you stop logging. The logged lines include prompts, entered commands, |
| output from commands, and diagnostic messages.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This log file contains information from when you started logging to when you stopped logging:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">================================================================================ |
| Spooling started at May 29, 2105 4:52:23 PM |
| ================================================================================ |
| |
| SQL> SET TRANSACTION ISOLATION LEVEL SERIALIZABLE; |
| |
| --- SQL operation complete. SQL>begin work; |
| |
| --- SQL operation complete. |
| |
| SQL> DELETE FROM employee WHERE empnum=32; |
| |
| -- 1 row(s) deleted. |
| |
| SQL> INSERT INTO employee |
| (empnum, first_name, last_name, deptnum, salary) values(51, 'JERRY', |
| 'HOWARD', 1000, 137000.00); |
| |
| -- 1 row(s) inserted. |
| |
| SQL> UPDATE dept SET manager=50 |
| where deptnum=1000; |
| |
| --- 1 row(s) updated. |
| |
| SQL> COMMIT WORK; |
| |
| --- SQL operation complete. |
| |
| SQL> LOG OFF</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_run_scripts">6. Run Scripts</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="script_create">6.1. Create a Script File</h3> |
| <div class="paragraph"> |
| <p>A script file that you run in trafci must be an ASCII text file that contains only these elements:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#script_sql_statements">SQL Statements</a></p> |
| </li> |
| <li> |
| <p><a href="#script_commands">Commands</a></p> |
| </li> |
| <li> |
| <p><a href="#script_comments">Comments</a></p> |
| </li> |
| <li> |
| <p><a href="#script_section_headers">Section Headers</a></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For an example, see <script_example, Example Script File>>.</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 use shell commands in a script file that you run in trafci. To create shell scripts |
| that run trafci, see <a href="#perl_or_python">Run trafci from Perl or Python</a>. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="script_sql_statements">6.2. SQL Statements</h3> |
| <div class="paragraph"> |
| <p>Script files support any of the various SQL statements that you can run in trafci. For more information about |
| SQL statements, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="script_commands">6.3. Commands</h3> |
| <div class="paragraph"> |
| <p>Most interface commands are supported in script files except the FC command. For a list of the interface commands, see |
| <a href="#commands">Commands</a>.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="script_comments">6.4. Comments</h3> |
| <div class="paragraph"> |
| <p>You can include comments anywhere in a script file. SQL also supports comments. Comments are useful for documenting |
| the functionality of the script file and for debugging. When debugging, use comments to disable |
| specific statements or commands without removing them from the script file.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To denote a comment in a script file, use two hyphens before the comment:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">-- comment</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The end of the line marks the end of the comment.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="script_section_headers">6.5. Section Headers</h3> |
| <div class="paragraph"> |
| <p>To create sections of commands within a script file, put a section header at the beginning of each section:</p> |
| </div> |
| <div class="exampleblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>?SECTION section-name</p> |
| </div> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The <code><em>section-name</em></code> cannot begin with a number or an underscore. Each section name in a script file should be unique |
| because trafci executes the first section that it finds that matches the section name in the <code>@</code> or <code>OBEY</code> command. |
| For more information, see the <a href="#cmd_at_sign">@ Command</a> <a href="#cmd_obey">OBEY Command</a>.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="script_example">6.6. Example Script File</h3> |
| <div class="paragraph"> |
| <p>This script file creates tables in the inventory schema:</p> |
| </div> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/script.jpg" alt="Sample script"></span></p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_run_a_script_file">6.7. Run a Script File</h3> |
| <div class="paragraph"> |
| <p>To run a script file in trafci, use the <code>@</code> or OBEY command. The <code>@</code> and <code>OBEY</code> commands run one script file at a time |
| in trafci. To run a script file when launching trafci, see <a href="#trafci_run_script">Run Script When Launching trafci</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="paragraph"> |
| <p>This <code>@</code> command runs a script file, <code>sch_invent.sql</code>, that creates tables in the inventory schema:</p> |
| </div> |
| <div class="exampleblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>@C:\ddl_scripts\sch_invent.sql</p> |
| </div> |
| </div> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| If the script file is outside the directory of the <code>trafci.cmd</code> or <code>trafci.sh</code> file (by default, the <code>bin</code> directory), |
| you must specify the full path of the script file in the <code>@</code> or <code>OBEY</code> command. |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL>@C:\ddl_scripts\sch_invent.sql |
| SQL>-- CREATE SCHEMA |
| SQL>CREATE SCHEMA INVENT; |
| |
| --- SQL operation complete. |
| |
| SQL>-- CREATE TABLES/VIEWS in SCHEMA INVENT |
| SQL> SET SCHEMA INVENT; |
| |
| --- SQL operation complete. |
| |
| SQL>CREATE TABLE INVENT.supplier ( |
| +> suppnum NUMERIC (4) UNSIGNED |
| +> NO DEFAULT |
| +> NOT NULL |
| +> ,suppname CHARACTER (18) |
| +> NO DEFAULT |
| +> NOT NULL |
| +> ,street CHARACTER (22) |
| +> NO DEFAULT |
| +> NOT NULL |
| +> ,city CHARACTER (14) |
| +> NO DEFAULT |
| +> NOT NULL |
| +> ,state CHARACTER (12) |
| +> NO DEFAULT |
| +> NOT NULL |
| +> ,postcode CHARACTER (10) |
| +> NO DEFAULT |
| +> NOT NULL |
| +> ,PRIMARY KEY (suppnum) |
| +> ); |
| |
| --- SQL operation complete.</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For more information about the <code>@</code> and <code>OBEY</code> commands, see the <a href="#cmd_at_sign">@ Command</a> and |
| the <a href="#cmd_obey">OBEY Command</a>.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_log_output">6.8. Log Output</h3> |
| <div class="paragraph"> |
| <p>To log output of an trafci session while running one script file at a time, use the <code>SPOOL</code> or <code>LOG</code> command. |
| When you run an <code>OBEY</code> or <code>@</code> command, trafci displays each command in the script file, the output for each |
| command, and diagnostic messages in trafci. The <code>SPOOL</code> or <code>LOG</code> command captures this output as it appears |
| in trafci and logs it in a log file.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, <a href="#interactive_log_output">Log Output</a>.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_run_scripts_in_parallel">6.9. Run Scripts in Parallel</h3> |
| <div class="paragraph"> |
| <p>In trafci, the <code>@</code> and <code>OBEY</code> commands allow you to run only one script file at a time. However, the <code>PRUN</code> command |
| allows you to run multiple script files simultaneously.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>PRUN</code> command is most useful for running sets of data definition language (DDL) statements simultaneously, which |
| speeds up the process of creating large databases. Put all dependent or related DDL statements in the same script file. |
| For more information on running scripts in parallel using the <code>PRUN</code> command, see the <a href="#cmd_prun">PRUN Command</a>.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_run_trafci_from_perl_or_python">7. Run trafci From Perl or Python</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>You can execute SQL statements in Perl or Python by invoking the trafci |
| Perl or Python wrapper script.</p> |
| </div> |
| <div class="paragraph"> |
| <p>These instructions assume that you installed the trafci product. For more information, |
| see <a href="#install">Install and Configure</a>.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_set_the_login_environment_variables">7.1. Set the Login Environment Variables</h3> |
| <div class="paragraph"> |
| <p>Before launching trafci from Perl or Python, set these login environment variables:</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 45%;"> |
| <col style="width: 55%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Environment Variable</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>TRAFCI_PERL_JSERVER=<JavaServer_jar_path></pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the Perl JavaServer JAR location.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>TRAFCI_PYTHON_JSERVER=<Jython_jar_path></pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the Jython JAR file location.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>TRAFCI_PERL_JSERVER_PORT=<port_number></pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the port on which the JavaServer is listening.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>The Trafodion Command Interface Installer Wizard can attempt to automatically download and install both the Perl JavaServer |
| and Jython open source extensions. If you wish to download and install them manually, refer to the instructions in the <code>README</code> file |
| in the samples directory.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To set the login environment variables, see the instructions for the operating system of the client workstation:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="#perlpython_env_windows">Set the Login Environment Variables on Windows</a>.</p> |
| </li> |
| <li> |
| <p><a href="#perlpython_env_linux">Set the Login Environment Variables on Linux or Unix</a>.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| The Perl and Python wrapper scripts do not require these environment variables: |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>TRAFCI_SERVER</code></p> |
| </li> |
| <li> |
| <p><code>TRAFCI_USER</code></p> |
| </li> |
| <li> |
| <p><code>TRAFCI_PASSWORD</code></p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="sect3"> |
| <h4 id="perlpython_env_windows">7.1.1. Set the Login Environment Variables on Windows</h4> |
| <div class="paragraph"> |
| <p>You can set the login environment variables for the session at command prompts, or you can set the login environment variables for |
| the system or user by including them in the System Properties.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="_set_login_environment_variables_on_the_command_line">Set Login Environment Variables on the Command Line</h5> |
| <div class="paragraph"> |
| <p>At each command prompt, enter one of these commands:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">set TRAFCI_PERL_JSERVER=<absolute-path-of-JavaServer.jar> |
| set TRAFCI_PYTHON_JSERVER=<absolute-path-of-Jython.jar> |
| set TRAFCI_PERL_JSERVER_PORT=<portnumber></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_set_login_environment_variables_in_the_system_properties">7.1.2. Set Login Environment Variables in the System Properties</h4> |
| <div class="olist arabic"> |
| <ol class="arabic"> |
| <li> |
| <p>Right-click the <strong>Computer</strong> icon on your desktop, and then select <strong>Properties</strong>:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/mycomp.jpg" alt="Select computer properties"></span></p> |
| </div> |
| </li> |
| <li> |
| <p>In the <strong>Control Panel</strong>, click the <strong>Advanced</strong> system settings.</p> |
| </li> |
| <li> |
| <p>In the <strong>System Properties</strong> dialog box, click the <strong>Advanced</strong> tab.</p> |
| <div style="page-break-after: always;"></div> |
| </li> |
| <li> |
| <p>Click the <strong>Environment Variables</strong> button:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/sysprop.jpg" alt="Click Environment Variables button"></span></p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </li> |
| <li> |
| <p>In the <strong>Environment Variables</strong> dialog box, click <strong>New</strong> under <em>System</em> or <em>User</em> variables, whichever you prefer.</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/envvar.jpg" alt="Environment Variables dialog box"></span></p> |
| </div> |
| </li> |
| <li> |
| <p>In the <strong>New System Variable</strong> (or <strong>New User Variable</strong>) dialog box, type the name of the login environment variable for the <em>Variable Name</em> and the |
| required value for the <em>Variable Value</em>, and then click <strong>OK</strong>:</p> |
| <div class="paragraph"> |
| <p><span class="image"><img src="images/logvar_new.jpg" alt="New System Variable dialog box"></span></p> |
| </div> |
| </li> |
| <li> |
| <p>Verify that the environment variable appears under <em>System</em> or <em>User</em> variables.</p> |
| </li> |
| <li> |
| <p>Repeat <a href="#perlpython_win_env_step5">Step 5</a> to <a href="#perlpython_win_env_step7">Step 7</a> for each login environment variable.</p> |
| </li> |
| <li> |
| <p>After adding all three environment variables, click <strong>OK</strong> in the <strong>Environment Variables and System Properties</strong> dialog boxes |
| to accept the changes.</p> |
| </li> |
| </ol> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="perlpython_env_linux">7.1.3. Set the Login Environment Variables on Linux or UNIX</h4> |
| <div class="paragraph"> |
| <p>You can set the login environment variables for the session at command prompts, or you can set the login environment variables |
| for each user by including the variables in the user profile on a Linux or UNIX client workstation.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="_set_login_environment_variables_on_the_command_line_2">Set Login Environment Variables on the Command Line</h5> |
| <div class="paragraph"> |
| <p>At each command prompt in any shell except the C shell, enter one of these commands:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">export TRAFCI_PERL_JSERVER=<absolute-path-of-JavaServer.jar> |
| export TRAFCI_PYTHON_JSERVER=<absolute-path-of-Jython.jar> |
| export TRAFCI_PERL_JSERVER_PORT=<portnumber></code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>At each command prompt in the C shell, enter one of these commands:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">setenv TRAFCI_PERL_SERVER=<absolute-path-of-JavaServer.jar> |
| setenv TRAFCI_PYTHON_JSERVER=<absolute-path-of-Jython.jar> |
| setenv TRAFCI_PERL_JSERVER_PORT=<portnumber></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="_setting_login_environment_variables_in_the_user_profile">Setting Login Environment Variables in the User Profile</h5> |
| <div class="paragraph"> |
| <p>To set the login environment variables in the user profile:</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="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">vi .profile</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Add these <code>export</code> commands (or <code>setenv</code> commands for the C shell) to the user profile.</p> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">export TRAFCI_PERL_JSERVER=<absolute-path-of-JavaServer.jar> |
| export TRAFCI_PYTHON_JSERVER=<absolute-path-of-Jython.jar> |
| export TRAFCI_PERL_JSERVER_PORT=<portnumber></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </li> |
| <li> |
| <p>To activate the changes, either log out and log in again or execute the user profile.</p> |
| <div class="paragraph"> |
| <p><strong>Example</strong></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">. .profile</code></pre> |
| </div> |
| </div> |
| </li> |
| </ol> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_perl_and_python_wrapper_scripts">7.2. Perl and Python Wrapper Scripts</h3> |
| <div class="paragraph"> |
| <p>The Perl or Python wrapper scripts enable you to run SQL statements and script files using a single connection or |
| multiple connections within Perl or Python programs. The Perl wrapper script is <code>trafci.pl</code>, and the Python wrapper |
| script is <code>trafci.py</code>. By default, these wrapper scripts are located in the <code>bin</code> directory:</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 30%;"> |
| <col style="width: 70%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Operating System</th> |
| <th class="tableblock halign-left valign-top">Directory</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Windows</p></th> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre><trafci-installation-directory>\Trafodion Command Interface\bin</pre></div></td> |
| </tr> |
| <tr> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Linux/Unix</p></th> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre><trafci-installation-directory>/trafci/bin</pre></div></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p><em>trafci-installation-directory</em> is the directory where you installed the trafci software files.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_launch_trafci_from_the_perl_or_python_command_line">7.3. Launch trafci From the Perl or Python Command Line</h3> |
| <div class="paragraph"> |
| <p>You can launch the Perl or Python wrapper scripts as shown below:</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 15%;"> |
| <col style="width: 50%;"> |
| <col style="width: 35%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Language</th> |
| <th class="tableblock halign-left valign-top">Launch Command</th> |
| <th class="tableblock halign-left valign-top">Example</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Perl</p></th> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>perl trafci.pl <perl-script-filename></pre></div></td> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>> perl trafci.pl example.pl</pre></div></td> |
| </tr> |
| <tr> |
| <th class="tableblock halign-left valign-top"><p class="tableblock">Python</p></th> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>python trafci.py <python-script-filename></pre></div></td> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>> python trafci.py example.py</pre></div></td> |
| </tr> |
| </tbody> |
| </table> |
| <div style="page-break-after: always;"></div> |
| <div class="sect3"> |
| <h4 id="_example_perl_program_code_sample_pl_code">7.3.1. Example Perl Program (<code>sample.pl</code>)</h4> |
| <div class="paragraph"> |
| <p>You can download the <code>sample.pl</code> example from |
| <a href="http://trafodion.apache.org/docs/command_interface/resources/source/sample.pl" class="bare">http://trafodion.apache.org/docs/command_interface/resources/source/sample.pl</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Alternatively, copy and paste the following code into a file named <code>sample.pl</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="perl">use lib 'C:\\Program Files (x86)\\Apache Software Foundation\\Trafodion Command Interface\\lib\\perl'; |
| use Session; |
| |
| # create a new session |
| $sess = Session->new(); |
| |
| # connect to the database |
| $sess->connect("user1","password","16.123.456.78","23400"); |
| |
| $retval=$sess->execute(" set schema TRAFODION.CI_SAMPLE "); |
| print $retval; |
| |
| # Execute sample queries |
| $retval=$sess->execute("select * from employee"); print $retval; |
| $retval=$sess->execute("get statistics"); print $retval; |
| |
| # disconnect from the database |
| print "\n\nSession 1: Disconnecting first session. \n\n"; |
| $sess->disconnect();</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_python_program_code_sample_py_code">7.3.2. Example Python Program (<code>sample.py</code>)</h4> |
| <div class="paragraph"> |
| <p>You can download the <code>sample.py</code> example from |
| <a href="http://trafodion.apache.org/docs/command_interface/resources/source/sample.py" class="bare">http://trafodion.apache.org/docs/command_interface/resources/source/sample.py</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Alternatively, copy and paste the following code into a file named <code>sample.py</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="python"><span class="keyword">import</span> <span class="include">os</span> <span class="keyword">import</span> <span class="include">sys</span> |
| |
| <span class="comment">## Modify this path</span> |
| sys.path.append(<span class="string"><span class="delimiter">"</span><span class="content">C:</span><span class="char">\\</span><span class="content">Program Files (x86)</span><span class="char">\\</span><span class="content">Apache Software Foundation</span><span class="char">\\</span><span class="content">Trafodion Command Interface</span><span class="char">\\</span><span class="content">lib</span><span class="char">\\</span><span class="content">python</span><span class="delimiter">"</span></span>) |
| <span class="keyword">import</span> <span class="include">Session</span> |
| |
| <span class="comment"># create a new session</span> |
| sess = Session.Session() |
| |
| <span class="comment"># Connect to the database</span> |
| x=sess. connect (<span class="string"><span class="delimiter">"</span><span class="content">user1</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">16.123.456.78</span><span class="delimiter">"</span></span>,<span class="string"><span class="delimiter">"</span><span class="content">23400</span><span class="delimiter">"</span></span>) |
| |
| <span class="comment"># Execute sample queries</span> |
| |
| <span class="comment"># execute takes the query string as argument</span> |
| setSchema = <span class="string"><span class="delimiter">"</span><span class="content">set schema TRAFODION.CI_SAMPLE</span><span class="delimiter">"</span></span> |
| selectTable = <span class="string"><span class="delimiter">"</span><span class="content">select * from employee</span><span class="delimiter">"</span></span> |
| getStats = <span class="string"><span class="delimiter">"</span><span class="content">get statistics</span><span class="delimiter">"</span></span> |
| |
| <span class="comment">#Contruct a list of SQL statements to be executed</span> |
| queryList = [setSchema, selectTable, getStats] <span class="keyword">print</span> <span class="string"><span class="delimiter">"</span><span class="char">\n</span><span class="delimiter">"</span></span>; |
| |
| <span class="keyword">for</span> query <span class="keyword">in</span> queryList: |
| <span class="keyword">print</span> sess.execute (query) |
| |
| <span class="comment"># disconnect the session</span> |
| sess.disconnect() |
| <span class="keyword">del</span> sess |
| sess=<span class="predefined-constant">None</span></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="commands">8. Commands</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>TrafCI supports these commands in the command-line interface or in script files that you run from the command-line interface.</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 50%;"> |
| <col style="width: 30%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Command</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| <th class="tableblock halign-left valign-top">Documentation</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>@</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Runs the SQL statements and interface commands contained in a specified script file.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_at_sign">@ Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>/</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Runs the previously executed SQL statement.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_slash">/ Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>ALIAS</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Maps a string to any interface or SQL command.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_alias">ALIAS Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>CLEAR</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Clears the command console so that only the prompt appears at the top of the screen.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_clear">CLEAR Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>CONNECT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Creates a new connection to the Trafodion database from a current or existing TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_connect">CONNECT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>DELAY</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Allows the TrafCI session to be in sleep mode for the specified interval.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_delay">DELAY Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>DISCONNECT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Terminates the connection to the Trafodion database.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_disconnect">DISCONNECT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>ENV</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays attributes of the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_env">ENV Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>EXIT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Disconnects from and exits the command-line interface.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_exit">EXIT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>FC</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Edits and re-executes a previous command. This command is restricted to the command-line |
| interface and is disallowed in script files.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_fc">FC Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>GET STATISTICS</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Returns formatted statistics for the last executed SQL statement.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_get_statistics">GET STATISTICS Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>GOTO</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Jumps to a point the command history specified by the <a href="#cmd_label">LABEL Command</a>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_goto">GOTO Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>HELP</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays help text for the interface commands.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_help">HELP Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>HISTORY</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays recently executed commands.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_history">HISTORY Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>IF&8230;THEN</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Allows the conditional execution of actions specified within the <code>IF…THEN</code> conditional statement.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_if_then">IF…THEN Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>LABEL</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Marks a point in the command history that you can jump to by using the <a href="#cmd_goto">GOTO Command</a>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_label">LABEL Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>LOCALHOST</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Executes client machine commands.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_localhost">LOCALHOST Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>LOG</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Logs commands and output from TrafCI to a log file.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_log">LOG Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>OBEY</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Runs the SQL statements and interface commands contained in a specified script file.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_obey">OBEY Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>PRUN</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Runs script files in parallel.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_prun">PRUN Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>QUIT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Disconnects from and exits TrafCI.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_quit">QUIT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>RECONNECT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Creates a new connection to the Trafodion database using the login credentials of the last |
| successful connection.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_reconnect">RECONNECT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>REPEAT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Re-executes a command.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_repeat">REPEAT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>RESET LASTERROR</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Resets the last error code to <code>0</code>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_reset_lasterror">RESET LASTERROR Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>RESET PARAM</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Clears all parameter values or a specified parameter value in the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_reset_param">RESET PARAM Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>RUN</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Runs the previously executed SQL statement.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_run">RUN Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SAVEHIST</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Saves the session history in a user-specified file.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_savehist">SAVEHIST Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SESSION</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays attributes of the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_session">SESSION Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET COLSEP</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the column separator and allows you to control the formatting of the result displayed for SQL queries.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_colsep">SET COLSEP Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET FETCHSIZE</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Changes the default fetchsize used by JDBC.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_fetchsize">SET FETCHSIZE Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET HISTOPT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the history option and controls how commands are added to the history buffer.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_histopt">SET HISTOPT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET IDLETIMEOUT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the idle timeout value for the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_idletimeout">SET IDLETIMEOUT</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET LIST_COUNT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the maximum number of rows to be returned by <code>SELECT</code> statements that are executed after this command.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_list_count">SET LIST_COUNT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET MARKUP</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the markup format and controls how results are displayed by TrafCI.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_markup">SET MARKUP Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET PARAM</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets a parameter value in the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_param">SET PARAM Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET PROMPT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the prompt of the current session to a specified string or to a session variable.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_prompt">SET PROMPT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET SQLPROMPT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the SQL prompt of the current session to a specified string. The default is <code>SQL</code>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_sqlprompt">SET SQLPROMPT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET SQLTERMINATOR</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Sets the SQL statement terminator of the current session to a specified string. |
| The default is a semicolon (<code>;</code>).</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_sqlterminator">SET SQLTERMINATOR Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET STATISTICS</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Automatically retrieves the statistics information for a query being executed.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_statistics">SET STATISTICS Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET TIME</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Causes the local time of the client workstation to be displayed as part of the interface prompt.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_time">SET TIME Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SET TIMING</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Causes the elapsed time to be displayed after each SQL statement executes.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_set_timing">SET TIMING Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW ACTIVITYCOUNT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Functions as an alias of <a href="#cmd_show_reccount">SHOW RECCOUNT Command</a>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_activitycount">SHOW ACTIVITYCOUNT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW ALIAS</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays all or a set of aliases available in the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_alias">SHOW ALIAS Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW ALIASES</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays all the aliases available in the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_aliases">SHOW ALIASES Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW CATALOG</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the current catalog of the TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_catalog">SHOW CATALOG Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW COLSEP</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the value of the column separator for the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_colsep">SHOW COLSEP Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW ERRORCODE</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Functions as an alias for the <a href="#cmd_show_lasterror">SHOW LASTERROR Command</a>.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_errorcode">SHOW ERRORCODE Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW FETCHSIZE</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the fetch size value for the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_fetchsize">SHOW FETCHSIZE Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW HISTOPT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the value that has been set for the history option of the current setting.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_histopt">SHOW HISTOPT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW IDLETIMEOUT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the idle timeout value of the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_idletimeout">SHOW IDLETIMEOUT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW LASTERROR</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the last error of the statement that was executed.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_lasterror">SHOW LASTERROR Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW LIST_COUNT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the maximum number of rows to be returned by <code>SELECT</code> statements in the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_list_count">SHOW LIST_COUNT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW MARKUP</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the value that has been set for the markup option for the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_markup">SHOW MARKUP Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW PARAM</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the parameters that are set in the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_param">SHOW PARAM Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW PREPARED</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the prepared statements in the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_prepared">SHOW PREPARED Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW RECCOUNT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the record count of the previous executed SQL statement.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_reccount">SHOW RECCOUNT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW REMOTEPROCESS</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the process name of the DCS server that is handling the current connection.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_remoteprocess">SHOW REMOTEPROCESS Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW SCHEMA</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the current schema of the TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_schema">SHOW SCHEMA Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW SESSION</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays attributes of the current TrafCI session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_session">SHOW SESSION Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW SQLPROMPT</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the value of the SQL prompt for the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_sqlprompt">SHOW SQLPROMPT Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW SQLTERMINATOR</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the SQL statement terminator of the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_sqlterminator">SHOW SQLTERMINATOR Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW STATISTICS</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays if statistics has been enabled or disabled for the current session.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_statistics">SHOW STATISTICS Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW TIME</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the setting for the local time in the SQL prompt.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_time">SHOW TIME Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SHOW TIMING</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the setting for the elapsed time.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_show_timing">SHOW TIMING Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>SPOOL</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Logs commands and output from TrafCI to a log file.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_spool">SPOOL Command</a></p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>VERSION</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Displays the build versions of the platform, database connectivity services, JDBC Type 4 Driver, and TrafCI.</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#cmd_version">VERSION Command</a></p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div style="page-break-after: always;"></div> |
| <div class="sect2"> |
| <h3 id="cmd_at_sign">8.1. @ Command</h3> |
| <div class="paragraph"> |
| <p>The <code>@</code> command executes the SQL statements and interface commands contained in a specified script file. The <code>@</code> command is |
| executed the same as the <code>OBEY</code> command. For more information on syntax and considerations, <a href="#cmd_obey">OBEY Command</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax">8.1.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">@{script-file | wild-card-pattern} [(section-name)]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>script-file</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of an ASCII text file that contains SQL statements, interface commands, and comments. If the script file exists outside the |
| local directory where you launch TrafCI (by default, the <code>bin</code> directory) specify the full directory path of the script file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>wild-card-pattern</em></code></p> |
| <div class="paragraph"> |
| <p>is a character string used to search for script files with names that match the character string. <code><em>wild-card-pattern</em></code> matches a string, |
| depending on the operating system for case-sensitivity, unless you enclose it within double quotes. To look for similar values, specify |
| only part of the characters of <code><em>wild-card-pattern</em></code> combined with these wild-card characters:</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 10%;"> |
| <col style="width: 90%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use an asterisk (<code><strong></code>) to indicate zero or more characters of any type. For example, <code>*art</strong></code> matches <code>SMART</code>, <code>ARTIFICIAL</code>, and <code>PARTICULAR</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use a question mark (<code>?</code>) to indicate any single character. For example, <code>boo?</code> matches <code>BOOK</code> and <code>BOOT</code> but not <code>BOO</code> or <code>BOOTS</code>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li> |
| <p><code>(<em>section-name</em>)</code></p> |
| <div class="paragraph"> |
| <p>is the name of a section within the <code><em>script-file</em></code> to execute. If you specify <code><em>section-name</em></code>, the <code>@</code> command executes the commands between |
| the header line for the specified section and the header line for the next section (or the end of the script file). |
| If you omit <code><em>section-name</em></code>, the <code>@</code> command executes the entire script file. For more information, <a href="#script_section_headers">Section Headers</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations">8.1.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>Space is disallowed between the <code>@</code> sign and the first character of the script name.</p> |
| </li> |
| <li> |
| <p>For additional considerations, see the <a href="#cmd_obey">OBEY Command</a>.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples">8.1.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>@</code> command runs the script file from the local directory (the same directory where you are running TrafCI):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> @ddl.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>@</code> command runs the script file in the specified directory on a Windows workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text"> SQL> @c:\my_files\ddl.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>@</code> command runs the script file in the specified directory on a Linux or UNIX workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> @./my_files/ddl.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_slash">8.2. / Command</h3> |
| <div class="paragraph"> |
| <p>The <code>/</code> command executes the previously executed SQL statement. This command does not repeat an interface command.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_2">8.2.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">/</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_2">8.2.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>The command does not require an SQL terminator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example">8.2.3. Example</h4> |
| <div class="paragraph"> |
| <p>This <code>/</code> command executes the previously executed <code>SELECT</code> statement:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT COUNT() FROM persnl.employee; |
| |
| (EXPR) |
| -------------------- |
| 62 |
| |
| --- 1 row(s) selected. |
| |
| `SQL>`/ |
| |
| (EXPR) |
| -------------------- |
| 62 |
| |
| --- 1 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_alias">8.3. ALIAS Command</h3> |
| <div class="paragraph"> |
| <p>The <code>ALIAS</code> command allows you to map a string to any interface or SQL command. The syntax of the interface or SQL command |
| is checked only when the mapped string is executed. This command replaces only the first token of a command string, which allows |
| the rest of the tokens to be treated as parameters.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_3">8.3.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">ALIAS value AS command SQL-terminator</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>value</em></code></p> |
| <div class="paragraph"> |
| <p>is a case-insensitive string without spaces. <code><em>Value</em></code> cannot be a command.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>command</em></code></p> |
| <div class="paragraph"> |
| <p>is an command or SQL command.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>SQL-terminator</em></code></p> |
| <div class="paragraph"> |
| <p>is the default terminator (<code>;</code>) or a string value defined for the statement terminator by the |
| <a href="#cmd_set_sqlterminator">SET SQLTERMINATOR Command</a>. For more information, see |
| <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_3">8.3.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>The <code>ALIAS</code> command lasts only for the duration of the session.</p> |
| </li> |
| <li> |
| <p>An alias on an alias is not supported.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_2">8.3.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command creates an alias named <code>.OS</code> to perform the <code>LOCALHOST (LH)</code> command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> ALIAS .OS AS LH;</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command executes the new <code>ALIAS</code> with the <code>ls</code> option:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> .OS ls |
| |
| trafci-perl.pl trafci-python.py trafci.cmd trafci.pl trafci.py trafci.sh</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command creates an alias named <code>.GOTO</code> to perform the <code>GOTO</code> command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> ALIAS .GOTO AS GOTO; |
| SQL> .GOTO mylabel</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>GOTO</code> statement executed, ignoring all commands until a <code>'LABEL MYLABEL'</code> command is encountered.</p> |
| </div> |
| </li> |
| <li> |
| <p>This command creates an alias named USE to perform the <code>SET SCHEMA</code> operation, uses the alias to set the schema to |
| <code>TRAFODION.USR</code>, and checks the current schema to verify that the alias worked correctly:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> ALIAS use AS "SET SCHEMA"; |
| SQL> use TRAFODION.USR; |
| SQL> SHOW SCHEMA |
| |
| SCHEMA USR</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_clear">8.4. CLEAR Command</h3> |
| <div class="paragraph"> |
| <p>The <code>CLEAR</code> command clears the interface window so that only the prompt appears at the top of the window. <code>CLEAR</code> does not clear the log file or |
| reset the settings of the session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_4">8.4.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">CLEAR</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_4">8.4.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>The <code>CLEAR</code> command does not require an SQL terminator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_2">8.4.3. Example</h4> |
| <div class="paragraph"> |
| <p>This CLEAR command clears the interface window:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> CLEAR</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>After the CLEAR command executes, the interface window appears with only the prompt showing:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_connect">8.5. CONNECT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>CONNECT</code> command creates a new connection to the database from the current or existing TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_5">8.5.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">CONNECT [ username [ /password ][@hostname]]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>username</em></code></p> |
| <div class="paragraph"> |
| <p>specifies the user name for logging in to the database platform.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If the user name is not specified, then TrafCI prompts for the user name.</p> |
| </li> |
| <li> |
| <p>If the user name contains spaces or special characters, such as a period (<code>.</code>), hyphen (<code>-</code>), or underscore (<code>_</code>), |
| then put the name within double quotes. For example: <strong>"sq.user-1"</strong>.</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><code><em>/password</em></code></p> |
| <div class="paragraph"> |
| <p>specifies the password of the user for logging in to the database platform.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If the password is not specified, then TrafCI prompts for the password.</p> |
| </li> |
| <li> |
| <p>If the password contains spaces or special characters, such as <code>@</code> or a single quote (<code>'</code>), then put the password |
| within double quotes. For example: <strong>"Tr@f0d!0n"</strong>.</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| <li> |
| <p><code><em>@hostname</em></code></p> |
| <div class="paragraph"> |
| <p>specifies the host name or IP address of the database platform to which you want the client to connect.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If the hostname is not specified, then the value is automatically used from the current TrafCI session.</p> |
| </li> |
| <li> |
| <p>If TrafCI was invoked with the <code>-noconnect</code> launch parameter, then you are prompted for a <code><em>hostname</em></code> value.</p> |
| </li> |
| </ul> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_5">8.5.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If TrafCI was invoked with the <code>-noconnect</code> launch parameter, then TrafCI prompts you for the values.</p> |
| </li> |
| <li> |
| <p>If the user name or password contains space or special characters, then you must put the name or password within double quotes.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_3">8.5.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command creates a new connection to the Trafodion database from the current or existing TrafCI session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> CONNECT |
| |
| User Name: user1 |
| Password: |
| |
| Connected to Trafodion</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command creates a new connection to the Trafodion database from the current or existing TrafCI session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> CONNECT user1/password |
| |
| Connected to Trafodion</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command creates a new connection to the Trafodion database from the current or existing TrafCI session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> CONNECT user1/password@host0101 |
| |
| Connected to Trafodion</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command creates a new connection to the Trafodion database from the current or existing TrafCI session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> CONNECT user2 |
| |
| Password: |
| |
| Connected to Trafodion</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_delay">8.6. DELAY Command</h3> |
| <div class="paragraph"> |
| <p>The <code>DELAY</code> command allows the TrafCI session to be in sleep mode for the specified interval.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_6">8.6.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">DELAY time [sec[ond][s] | min[ute][s]]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>time</em></code></p> |
| <div class="paragraph"> |
| <p>is an integer.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_6">8.6.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If <code>seconds</code> or <code>minutes</code> are not specified, then the default is <code>seconds</code>.</p> |
| </li> |
| <li> |
| <p>The maximum delay limit is 3600 seconds. You can override this value by setting <code>trafci.maxDelayLimit</code> in <code>_JAVA_OPTIONS</code>. |
| The unit is seconds for <code>trafci.maxDelayLimit</code>.</p> |
| </li> |
| <li> |
| <p>This command does not require an SQL terminator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_4">8.6.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This DELAY command puts the TrafCI session to sleep for 5 seconds before executing the next command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> DELAY 5 secs |
| SQL> SHOW VIEWS</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This DELAY command puts TrafCI session to sleep for 5 minutes before executing the next command, which is to exit the session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> DELAY 5 mins |
| SQL> EXIT</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_disconnect">8.7. DISCONNECT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>DISCONNECT</code> command terminates the connection from the database, not from TrafCI.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_7">8.7.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">DISCONNECT [WITH] [status] [IF {condition}]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><em>status</em></p> |
| <div class="paragraph"> |
| <p>is any 1-byte integer. <code><em>status</em></code> is a shell return value, and the range of allowable values is platform dependent.</p> |
| </div> |
| </li> |
| <li> |
| <p><em>condition</em></p> |
| <div class="paragraph"> |
| <p>is the same as the condition parameter defined for the <a href="#cmd_if_then">IF&8230;THEN Command</a>. See <a href="#cmd_conditional_parameters">Condition Parameter</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_7">8.7.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>After you disconnect from the Trafodion database, you can still run these interface commands:</p> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 15.7894%;"> |
| <col style="width: 21.0526%;"> |
| <col style="width: 29.4736%;"> |
| <col style="width: 33.6844%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ALIAS</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">HELP</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SAVEHIST</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW SQLTERMINATOR</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">CLEAR</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">HISTORY</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SESSION</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW TIME</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">CONNECT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">LABEL</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW COLSEP</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW TIMING</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">DELAY</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">LOCALHOST</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW HISTOPT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SHOW ALIAS/ALIASES</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">DISCONNECT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">LOG</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW IDLETIMEOUT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SHOW SESSION</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">ENV</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">QUIT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW MARKUP</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SPOOL</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">EXIT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">REPEAT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET/SHOW PARAM</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">VERSION</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">FC</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">RESET LASTERROR</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">SET PROMPT</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">GOTO</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_5">8.7.3. Examples</h4> |
| <div class="paragraph"> |
| <p>This command terminates the connection to the Trafodion database. You can connect to the Trafodion database by using the <code>CONNECT</code> |
| and <code>RECONNECT</code> commands:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> DISCONNECT |
| |
| Session Disconnected. Please connect to the database by using |
| connect/reconnect command.</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_env">8.8. ENV Command</h3> |
| <div class="paragraph"> |
| <p><code>ENV</code> displays attributes of the current TrafCI session. You can also use the <code>SESSION</code> and <code>SHOW SESSION</code> commands to perform the same function.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_8">8.8.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">ENV</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_8">8.8.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>ENV displays these attributes:</p> |
| </li> |
| </ul> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 15%;"> |
| <col style="width: 85%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Attribute</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>COLSEP</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current column separator, which is used to control how query results are displayed. For more information, see <a href="#cmd_set_colsep">SET COLSEP Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>HISTOPT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current history options, which controls how the commands are added to the history buffer. For more information, see <a href="#cmd_set_histopt">SET HISTOPT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>IDLETIMEOUT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current idle timeout value, which determines when the session expires after a period of inactivity. By default, the idle timeout is <code>30 minutes</code>. |
| For more information, see <a href="#interactive_idle_timeout">Set and Show Session Idle Timeout Value</a> and <a href="#cmd_set_idletimeout">SET IDLETIMEOUT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LIST_COUNT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current list count, which is the maximum number of rows that can be returned by SELECT statements. By default, the list count is all rows. |
| For more information, see <a href="#cmd_set_list_count">SET LIST_COUNT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LOG FILE</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current log file and the directory containing the log file. By default, logging during a session is turned <code>off</code>. |
| For more information, see <a href="#interactive_log_output">Log Output</a>, and <a href="#cmd_log">LOG Command</a> or <a href="#cmd_spool">SPOOL Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LOG OPTIONS</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current logging options. By default, logging during a session is turned <code>off</code>, and this attribute does not appear in the output. |
| For more information, see the <a href="#cmd_log">LOG Command</a> or <a href="#cmd_spool">SPOOL Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>MARKUP</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current markup option selected for the session. The default option is <code>RAW</code>. For more information, <a href="#cmd_set_markup">SET MARKUP Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PROMPT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current prompt for the session. For example, the default is <code>SQL></code>. |
| For more information, <a href="#interactive_customize_prompt">Customize the Standard Prompt</a> and <a href="#cmd_set_prompt">SET PROMPT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SCHEMA</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current schema. The default is <code>USR</code>. For more information, see <a href="#interactive_set_show_current_schema">Set and Show the Current Schema</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SERVER</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Host name and port number that you entered when logging in to the database platform. For more information, see <a href="#trafci_login">Log In to Database Platform</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SQLTERMINATOR</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current SQL statement terminator. The default is a semicolon (<code>;</code>). |
| For more information, see <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a> and <a href="#cmd_show_sqlterminator">SHOW SQLTERMINATOR Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>STATISTICS</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current setting (<code>on</code> or <code>off</code>) of statistics. For more information, see the <a href="#cmd_set_statistics">SET STATISTICS Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>TIME</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current setting (<code>on</code> or <code>off</code>) of the local time as part of the prompt. When this command is set to <code>on</code>, military time is displayed. |
| By default, the local time is <code>off</code>. For more information, see <a href="#interactive_customize_prompt">Customize the Standard Prompt</a> and <a href="#cmd_set_time">SET TIME Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>TIMING</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current setting (<code>on</code> or <code>off</code>) of the elapsed time. By default, the elapsed time is <code>off</code>. |
| For more information, see <a href="#interactive_display_elapsed_time">Display the Elapsed Time</a> and <a href="#cmd_set_timing">SET TIMING Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>USER</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">User name that you entered when logging in to the database platform. |
| For more information, <a href="#trafci_login">Log In to Database Platform</a>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_6">8.8.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>ENV</code> command displays the attributes of the current session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> ENV |
| |
| COLSEP " " |
| HISTOPT DEFAULT [No expansion of script files] |
| IDLETIMEOUT 0 min(s) [Never Expires] |
| LIST_COUNT 0 [All Rows] |
| LOG FILE c:\session.txt |
| LOG OPTIONS APPEND,CMDTEXT ON |
| MARKUP RAW |
| PROMPT SQL> |
| SCHEMA SEABASE |
| SERVER sqws135.houston.host.com:23400 |
| SQLTERMINATOR ; |
| STATISTICS OFF |
| TIME OFF |
| TIMING OFF |
| USER user1</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>ENV</code> command shows the effect of setting various session attributes:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">4:16:43 PM > ENV |
| |
| COLSEP " " |
| HISTOPT DEFAULT [No expansion of script files] |
| IDLETIMEOUT 30 min(s) |
| LIST_COUNT 0 [All Rows] |
| LOG OFF |
| MARKUP RAW |
| PROMPT SQL> |
| SCHEMA SEABASE |
| SERVER sqws135.houston.host.com:23400 |
| SQLTERMINATOR ; |
| STATISTICS OFF |
| TIME OFF |
| TIMING OFF |
| USER user1 |
| |
| 4:16:49 PM ></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_exit">8.9. EXIT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>EXIT</code> command disconnects from and exits TrafCI. <code>EXIT</code> can return a status code. |
| If no status code is specified, then <code>0</code> (zero) is returned by default. In addition, a conditional statement |
| can be appended to the command.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_9">8.9.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">EXIT [WITH] [status] [IF {condition}]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>status</em></code></p> |
| <div class="paragraph"> |
| <p>is any 1-byte integer. <code><em>status</em></code> is a shell return value, and the range of allowable values is platform dependent.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>condition</em></code></p> |
| <div class="paragraph"> |
| <p>is the same as the condition parameter defined for the <a href="#cmd_if_then">IF&8230;THEN Command</a>. |
| See <a href="#cmd_conditional_parameter">Condition Parameter</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_9">8.9.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_7">8.9.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command disconnects from and exits TrafCI, which disappears from the screen:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> EXIT</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>In a script file, the conditional exit command causes the script file to quit running and disconnect from |
| and exit TrafCI when the previously run command returns error code <code>4082</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">LOG c:\errorCode.log |
| SELECT * FROM employee; |
| EXIT IF errorcode=4082 |
| LOG OFF</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>These results are logged when error code 4082 occurs:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM employee; |
| |
| **** ERROR[4082] Table, view or stored procedure TRAFODION.USR.EMPLOYEE does not exist or is inaccessible. |
| |
| SQL> EXIT IF errorcode=4082</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>The following two examples are equivalent:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> EXIT -1 IF LASTERROR <> 0 |
| SQL> EXIT WITH -1 IF LASTERROR != 0</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This example exits TrafCI if the last error code is equal to <code>4082</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> EXIT WITH 82 IF LASTERROR == 4082 |
| SQL> EXIT -- default status is 0</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_fc">8.10. FC Command</h3> |
| <div class="paragraph"> |
| <p>The <code>FC</code> command allows you to edit and reissue a command in the history buffer of an TrafCI session. |
| You can display the commands in the history buffer by using the <code>HISTORY</code> command. For information about the history |
| buffer, see the <a href="#cmd_history">HISTORY Command</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_10">8.10.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">FC [text | [-]number]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>text</em></code></p> |
| <div class="paragraph"> |
| <p>is the beginning text of a command in the history buffer. Case is not significant in matching the text to a command.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em class="-">number</em></code></p> |
| <div class="paragraph"> |
| <p>is either a positive integer that is the ordinal number of a command in the history buffer or a negative integer that indicates the position of |
| a command relative to the most recent command.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Without text or number, <code>FC</code> retrieves the most recent command.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_10">8.10.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>You cannot execute this command in a script file. You can execute this command only at a command prompt.</p> |
| </li> |
| <li> |
| <p>As each line of the command is displayed, you can modify the line by entering these editing commands (in uppercase or lowercase letters) on |
| the line below the displayed command line:</p> |
| </li> |
| </ul> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 80%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Edit Command</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>D</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Deletes the character immediately above the letter <code>D</code>. Repeat to delete more characters.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">`I`<em>characters</em></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Inserts characters in front of the character immediately above the letter <code>I</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">`R`<em>characters</em></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Replaces existing characters one-for-one with characters, beginning with the character immediately above the letter <code>R</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><em>characters</em></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Replaces existing characters one-for-one with characters, beginning with the first character immediately above characters. |
| <em>`characters`</em> must begin with a non-blank character.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>To specify more than one editing command on a line, separate the editing commands with a double slash (<code>//</code>). The end of a line terminates an |
| editing command or a set of editing commands.</p> |
| </div> |
| <div class="paragraph"> |
| <p>After you edit a line of the command, TrafCI displays the line again and allows you to edit it again. Press <strong>Enter</strong> without specifying editing |
| commands to stop editing the line. If that line is the last line of the command, pressing <strong>Enter</strong> executes the command.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To terminate a command without saving changes to the command, use the double slash (<code>//</code>), and then press <strong>Enter</strong>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_8">8.10.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Re-execute the most recent command that begins with SH:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> FC SH |
| SQL> SHOW SCHEMA |
| ....</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Pressing <strong>Enter</strong> executes the <code>SHOW SCHEMA</code> command and displays the current schema, <code>PERSNL</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> FC SH |
| SQL> SHOW SCHEMA |
| .... |
| |
| SCHEMA PERSNL |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Correct an SQL statement that you entered incorrectly by using the delete (<code>D</code>) editing command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM persnl.employee; |
| |
| *** ERROR[15001] A syntax error occurred at or before: |
| SELECCT * FROM persnl.employee; |
| ^ |
| SQL> FC |
| SQL> SELECCT * FROM persnl.employee; |
| .... d |
| SQL>SELECT * FROM persnl.employee; |
| ....</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Pressing <strong>Enter</strong> executes the corrected <code>SELECT</code> statement.</p> |
| </div> |
| </li> |
| <li> |
| <p>Correct an SQL statement that you entered incorrectly by using more than one editing command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELT * FROMM persnl.employee; |
| |
| *** ERROR[15001] A syntax error occurred at or before: |
| SELT * FROMM persnl.employee; |
| ^ |
| SQL> FC |
| SQL> SELT * FROMM persnl.employee; |
| .... iEX// d |
| SQL> SELECT * FROM persnl.employee; |
| ....</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Pressing <strong>Enter</strong> executes the corrected <code>SELECT</code> statement.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Modify a previously executed statement by replacing a value in the <code>WHERE</code> clause with another value:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT first_name, last_name |
| +> FROM persnl.employee |
| +> WHERE jobcode=111; |
| |
| --- 0 row(s) selected. |
| |
| SQL> FC |
| SQL> SELECT first_name, last_name |
| .... |
| SQL> FROM persnl.employee |
| .... |
| SQL> WHERE jobcode=111; |
| 450 |
| .... |
| SQL> WHERE jobcode=450; |
| ....</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Pressing Enter lists the first and last names of all of the employees whose job code is <code>450</code>.</p> |
| </div> |
| </li> |
| <li> |
| <p>Modify a previously executed statement by replacing a column name in the select list with another column name:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT first_name, last_name |
| +> FROM persnl.employee |
| +> WHERE jobcode=450; |
| |
| FIRST_NAME LAST_NAME |
| --------------- -------------------- |
| MANFRED CONRAD |
| WALTER LANCASTER |
| JOHN JONES |
| KARL HELMSTED |
| THOMAS SPINNER |
| |
| --- 5 row(s) selected. |
| |
| SQL> FC |
| SQL> SELECT first_name, last_name |
| .... R empnum, |
| SQL> SELECT empnum, last_name |
| .... |
| |
| SQL> FROM persnl.employee |
| .... |
| |
| SQL> WHERE jobcode=450; |
| ....</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>Pressing <strong>Enter</strong> lists the employee number and last names of all employees whose job code is <code>450</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">EMPNUM LAST_NAME |
| ------ -------------------- |
| 180 CONRAD |
| 215 LANCASTER |
| 216 JONES |
| 225 HELMSTED |
| 232 SPINNER |
| |
| --- 5 row(s) selected. |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_get_statistics">8.11. GET STATISTICS Command</h3> |
| <div class="paragraph"> |
| <p>The GET STATISTICS command returns formatted statistics for the last executed SQL statement.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_11">8.11.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">GET STATISTICS</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_description_of_returned_values">8.11.2. Description of Returned Values</h4> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 30%;"> |
| <col style="width: 70%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Value</th> |
| <th class="tableblock halign-left valign-top">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Records Accessed</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of rows returned by disk process to <code>EID</code> (Executor In Disk process).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Records Used</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of rows returned by <code>EID</code> after selection.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Disk IOs</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of actual disk IOs done by disk process.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Message Count</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of messages sent/received between file system and disk process.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Message Bytes</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of message bytes sent/received between file system and disk process.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Lock Escl</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of lock escalations.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Lock Wait</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Number of lock waits.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>Disk Process Busy Time</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">CPU time for disk process processes for the specified table.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_11">8.11.3. Considerations</h4> |
| <div class="paragraph"> |
| <p>The command requires an SQL terminator.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_9">8.11.4. Examples</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM job; |
| |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 1234 ENGINEER |
| 450 PROGRAMMER |
| 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 11 row(s) selected. |
| |
| SQL> GET STATISTICS; |
| |
| Start Time 21:45:34.082329 |
| End Time 21:45:34.300265 |
| Elapsed Time 00:00:00.217936 |
| Compile Time 00:00:00.002423 |
| Execution Time 00:00:00.218750 |
| |
| |
| Table Name Records Records Disk Message Message Lock Lock Disk Process |
| Accessed Used I/Os Count Bytes Escl Wait Busy Time |
| TRAFODION.TOI.JOB 2 2 0 4 15232 0 0 363 |
| |
| --- SQL operation complete.</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_goto">8.12. GOTO Command</h3> |
| <div class="paragraph"> |
| <p>The GOTO command allows you to jump to a designated point in the command history. The point in the command history is designated |
| by a <code>LABEL</code> command. All commands executed after a <code>GOTO</code> statement are ignored until the specified label is set. To set a label, |
| use the <a href="#cmd_label">LABEL Command</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_12">8.12.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">GOTO {label}</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>label</em></code></p> |
| <div class="paragraph"> |
| <p>is a string of characters without quotes and spaces, or a quoted string.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_12">8.12.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>The <code>GOTO</code> command cannot currently jump back in the command history; it is a forward-only command.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_10">8.12.3. Examples</h4> |
| <div class="paragraph"> |
| <p>These examples show the use of the <code>GOTO</code> and <code>LABEL</code> commands:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> GOTO ViewManagers |
| SQL> SELECT FROM Employees; -- skipped |
| SQL> SHOW RECCOUNT; -- skipped |
| SQL> LABEL ViewManagers |
| SQL> SELECT FROM Managers; |
| SQL> GOTO "View Customers" |
| SQL> SELECT FROM Invoices; -- skipped |
| SQL> LABEL "View Customers" |
| SQL> SELECT FROM Customers;</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_help">8.13. HELP Command</h3> |
| <div class="paragraph"> |
| <p>The HELP command displays help text for the commands. See <a href="#commands">Commands</a> for a descriptions of the commands.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_syntax_13">8.14. Syntax</h3> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">HELP [command-name]</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><code><em>command-name</em></code></p> |
| </div> |
| <div class="paragraph"> |
| <p>is the name of a command.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If you do not specify a command, then TrafCI returns a list of all commands.</p> |
| </li> |
| <li> |
| <p>If you specify <code>SET</code>, then TrafCI returns a list of all SET commands.</p> |
| </li> |
| <li> |
| <p>If you specify <code>SHOW</code>, then TrafCI returns a list of all <code>SHOW</code> commands.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_13">8.14.1. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_11">8.14.2. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>HELP</code> command lists all the interface commands that are supported:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HELP</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>HELP</code> command lists all the <code>SET</code> commands that are supported:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HELP SET</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>HELP</code> command lists all the <code>SHOW</code> commands that are supported:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HELP SHOW</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>HELP</code> command shows help text for <code>SET IDLETIMEOUT</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HELP SET IDLETIMEOUT</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_history">8.15. HISTORY Command</h3> |
| <div class="paragraph"> |
| <p>The <code>HISTORY</code> command displays recently executed commands, identifying each command by a number that you can use |
| to re-execute or edit the command.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_14">8.15.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">HISTORY [number]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>number</em></code></p> |
| <div class="paragraph"> |
| <p>is the number of commands to display. The default number is <code>10</code>. The maximum number is <code>100</code>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_14">8.15.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>You can use the <code>FC</code> command to edit and re-execute a command in the history buffer, or use the |
| <code>REPEAT</code> command to re-execute a command without modifying it. See <a href="#cmd_fc">FC Command</a> or |
| <a href="#cmd_repeat">REPEAT Command</a>.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_3">8.15.3. Example</h4> |
| <div class="paragraph"> |
| <p>Display the three most recent commands and use <code>FC</code> to redisplay one:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HISTORY 3 |
| |
| 14> SET SCHEMA SALES; |
| 15> SHOW TABLES |
| 16> SHOW VIEWS |
| |
| SQL> FC 14 |
| |
| SQL> SET SCHEMA sales |
| ....</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Now you can use the edit capabilities of <code>FC</code> to modify and execute a different <code>SET SCHEMA</code> statement.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_if_then">8.16. IF…THEN Command</h3> |
| <div class="paragraph"> |
| <p><code>IF…THEN</code> statements allow for the conditional execution of actions. If the condition is met, the action |
| is executed; otherwise, no action is taken.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_15">8.16.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">IF {condition} THEN {action} {SQL-terminator}</code></pre> |
| </div> |
| </div> |
| <div id="cmd_condition_parameter" class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>condition</em></code></p> |
| <div class="paragraph"> |
| <p>The condition parameter (<code><em>condition</em></code>) is a Boolean statement structured as follows:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">( {variable-name | value} {operator} {variable-name | value}</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p><code><em>variable-name</em></code></p> |
| <div class="paragraph"> |
| <p>is one of:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">{ LASTERROR |
| | RECCOUNT |
| | ACTIVITYCOUNT |
| | ERRORCODE |
| | [%]any ENV variable | any SQL parameter |
| }</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p><code><em>value</em></code></p> |
| <div class="paragraph"> |
| <p>is any integer or a quoted string, where the quoted string is any non-quote character. <code>\</code> is the optional escape character.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>operator</em></code></p> |
| <div class="paragraph"> |
| <p>is one of:</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 30%;"> |
| <col style="width: 70%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Operator</th> |
| <th class="tableblock halign-left valign-top">Meaning</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>== | =</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">equal to</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre><> | != | ~= | ^=</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">not equal to</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>></pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">greater than</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre>>=</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">greater than or equal to</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre><</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">less than</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><div class="literal"><pre><=</pre></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">less than or equal to</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li> |
| <p><code><em>action</em></code></p> |
| <div class="paragraph"> |
| <p>The action parameter (<code><em>action</em></code>) is any interface or SQL command.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>SQL Terminator</em></code></p> |
| <div class="paragraph"> |
| <p>The SQL terminator (<code><em>SQL-terminator</em></code>) is the default terminator (<code>;</code>) or a string value defined for the statement |
| terminator by the <a href="#cmd_set_sqlterminator">SET SQLTERMINATOR Command</a>. |
| See <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_15">8.16.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>IF…THEN</code> is itself an action. Thus, nested <code>IF…THEN</code> statements are allowed.</p> |
| </li> |
| <li> |
| <p>An action must end with the SQL terminator, even if the action is an interface command.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_12">8.16.3. Examples</h4> |
| <div class="paragraph"> |
| <p>These commands show multiple examples of <code>IF…THEN</code> statements:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> INVOKE employees |
| SQL> -- ERROR 4082 means the table does not exist |
| SQL> IF ERRORCODE != 4082 THEN GOTO BeginPrepare |
| SQL> CREATE TABLE employees(ssn INT PRIMARY KEY NOT NULL NOT DROPPABLE, fname VARCHAR(50), lname VARCHAR(50), hiredate DATE DEFAULT CURRENT_DATE); |
| SQL> LABEL beginprepare |
| SQL> PREPARE empSelect FROM |
| +> SELECT * FROM |
| +> employees |
| +> WHERE SSN=?empssn; |
| SQL> IF user == "alice" THEN SET PARAM ?empssn 987654321; |
| SQL> IF %user == "bob" THEN SET PARAM ?empssn 123456789; |
| SQL> EXECUTE empselect |
| SQL> IF user == "alice" THEN |
| +> IF activitycount == 0 THEN GOTO insertalice; |
| SQL> IF user == "bob" THEN IF activitycount == 0 THEN GOTO insertbob; |
| SQL> EXIT |
| SQL> LABEL insertalice |
| SQL> INSERT INTO employees(ssn, fname, lname) VALUES(987654321, 'Alice', 'Smith'); |
| SQL> EXIT |
| SQL> LABEL insertbob |
| SQL> INSERT INTO employees(ssn, fname, lname) VALUES(123456789, 'Bob', 'Smith'); |
| SQL> EXIT</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_label">8.17. LABEL Command</h3> |
| <div class="paragraph"> |
| <p>The LABEL command marks a point in the command history that you can jump to by using the <code>GOTO</code> command. |
| For more information, see the <a href="#cmd_goto">GOTO Command</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_16">8.17.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">LABEL {label}</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>label</em></code></p> |
| <div class="paragraph"> |
| <p>is a string of characters without quotes and spaces, or a quoted string.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_16">8.17.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_13">8.17.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command creates a label using a string of characters:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LABEL MyNewLabel</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command creates a label using a quoted string:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LABEL "Trafodion Label"</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_localhost">8.18. LOCALHOST Command</h3> |
| <div class="paragraph"> |
| <p>The <code>LOCALHOST</code> command allows you to execute client machine commands.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_17">8.18.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">LOCALHOST | LH <client M/C commands></code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_17">8.18.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>The <code>LOCALHOST</code> command has a limitation. When input is entered for the operating system commands |
| (for example, <code>date</code>, <code>time</code>, and <code>cmd</code>), the input is not visible until you hit the <code>enter</code> key.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_14">8.18.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If you are using a Windows system, dir lists the contents of the directory name. Similarly, if you are on a UNIX system you enter |
| <code>LOCALHOST LS</code> to display the contents of the folder.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOCALHOST dir |
| |
| Volume in drive C is E-Client |
| Volume Serial Number is DC4F-5B3B |
| |
| Directory of c:\Program Files (x86)\Apache Software Foundation\Trafodion Command |
| |
| Interface\bin 05/11/2105 01:17 PM <DIR> |
| 05/11/2105 01:17 PM <DIR> |
| 05/16/2105 09:47 AM 1,042 trafci-perl.pl |
| 05/16/2105 09:47 AM 1,017 trafci-python.pl |
| 05/16/2105 09:47 AM 752 trafci.cmd |
| 05/16/2105 09:47 AM 1,416 trafci.pl |
| 05/16/2105 09:47 AM 2,388 trafci.py |
| 05/16/2105 09:47 AM 3,003 trafci.sh |
| 6 Files(s) 19,491 bytes |
| 2 Dir (s) 57,686,646,784 bytes free |
| |
| SQL> LH mkdir c:\trafci -- Will create a directory c:\trafci on your local machine.</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the elapsed time information because the <code>SET TIMING</code> command is set to <code>ON</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING ON |
| SQL> LOCALHOST ls |
| |
| trafci-perl.pl |
| trafci-python.py |
| trafci.cmd |
| trafci.pl |
| trafci.py |
| trafci.sh |
| |
| Elapsed :00:00:00.078</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_log">8.19. LOG Command</h3> |
| <div class="paragraph"> |
| <p>The <code>LOG</code> command logs the entered commands and their output from TrafCI to a log file. |
| If this is an obey script file, then the command text from the obey script file is shown on the console.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_18">8.19.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">LOG { ON [CLEAR, QUIET, CMDTEXT {ON | OFF}] |
| | log-file [CLEAR, QUIET, CMDTEXT {ON | OFF}] |
| | OFF |
| }</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>ON</code></p> |
| <div class="paragraph"> |
| <p>starts the logging process and records information in the <code>sqlspool.lst</code> file in the <code>bin</code> directory.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>CLEAR</code></p> |
| <div class="paragraph"> |
| <p>instructs TrafCI to clear the contents of the sqlspool.lst file before logging new information to the file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>QUIET</code></p> |
| <div class="paragraph"> |
| <p>specifies that the command text is displayed on the screen, but the results of the command are written only to the log file and not to the screen.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>CMDTEXT ON</code></p> |
| <div class="paragraph"> |
| <p>specifies that the command text and the log header are displayed in the log file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>CMDTEXT OFF</code></p> |
| <div class="paragraph"> |
| <p>specifies that the command text and the log header are not displayed in the log file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>log-file</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of a log file into which TrafCI records the entered commands and their output. If you want the log file to exist outside the local |
| directory where you launch TrafCI (by default, the <code>bin</code> directory), specify the full directory path of the log file. The log file does not |
| need to exist, but the specified directory must exist before you execute the <code>LOG</code> command.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>log-file</em> CLEAR</code></p> |
| <div class="paragraph"> |
| <p>instructs TrafCI to clear the contents of the specified <code><em>log-file</em></code> before logging new information to the file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>OFF</code></p> |
| <div class="paragraph"> |
| <p>stops the logging process.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_18">8.19.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>Use a unique name for each log file to avoid writing information from different TrafCI sessions into the same log file.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_15">8.19.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command starts the logging process and records information to the <code>sqlspool.lst</code> file in the <code>bin</code> directory:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG ON</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to an existing log file, <code>persnl_updates.log</code>, |
| in the local directory (the same directory where you are running TrafCI):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG persnl_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to a log file, |
| <code>sales_updates.log</code>, in the specified directory on a Windows workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\log_files\sales_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to a log file, |
| <code>sales_updates.log</code>, in the specified directory on a Linux or UNIX workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG ./log_files/sales_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and clears existing information from the log file before |
| logging new information to the file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG persnl_ddl.log CLEAR</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command start the logging process, clears existing information from the log file, and specifies |
| that the command text and log header is not displayed in the log file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\temp\a.txt clear, CMDTEXT OFF |
| SQL> (SELECT * FROM trafodion.toi.job |
| +>; |
| |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 10 row(s) selected. |
| |
| SQL> log off |
| |
| Output of c:\temp\a.txt |
| |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 10 row(s) selected</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command start the logging process, clears existing information from the log file, specifies that no output appears on the console |
| window, and the quiet option is enabled:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\temp\b.txt CLEAR, CMDTEXT OFF, QUIET |
| SQL> SELECT |
| +> FROM trafodion.toi.job; + |
| SQL> LOG OFF |
| |
| Output of c:\temp\b.txt |
| |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 10 row(s) selected</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This command stops the logging process:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG OFF</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_log_output">Log Output</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_obey">8.20. OBEY Command</h3> |
| <div class="paragraph"> |
| <p>The <code>OBEY</code> command executes the SQL statements and interface commands of a specified script file or an |
| entire directory. This command accepts a single filename or a filename with a wild-card pattern specified. |
| Executing the <code>OBEY</code> command without optional parameters prompts you to enter a filename. If a filename is |
| not specified, then <code>*.sql</code> is used.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_19">8.20.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">OBEY {script-file | wild-card-pattern} [(section-name)]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>script-file</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of an ASCII text file that contains SQL statements, interface commands, and comments. If the script file |
| exists outside the local directory where you launch TrafCI (by default, the <code>bin</code> directory), specify the full directory |
| path of the script file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>wild-card-pattern</em></code></p> |
| <div class="paragraph"> |
| <p>is a character string used to search for script files with names that match the character string. <code><em>wild-card-pattern</em></code> |
| matches a string, depending on the operating system for case-sensitivity, unless you enclose it within double quotes. |
| To look for similar values, specify only part of the characters of <code><em>wild-card-pattern</em></code> combined with these |
| wild-card characters:</p> |
| </div> |
| </li> |
| <li> |
| <p><code>(<em>section-name</em>)</code></p> |
| <div class="paragraph"> |
| <p>is the name of a section within the <code><em>script-file</em></code> to execute. If you specify <code><em>section-name</em></code>, the <code>OBEY</code> command |
| executes the commands between the header line for the specified section and the header line for the next section |
| (or the end of the script file). If you omit <code><em>section-name</em></code>, the <code>OBEY</code> command executes the entire script file. |
| For more information, see <a href="#script_section_headers">Section Headers</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_19">8.20.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>Put a space between <code>OBEY</code> and the first character of the file name.</p> |
| </li> |
| <li> |
| <p>You can execute this command in a script file.</p> |
| </li> |
| <li> |
| <p>Before putting dependent SQL statements across multiple files, consider the order of the file execution. If a directory |
| is not passed to the <code>OBEY</code> command, the file or wild card is assumed to be in the current working directory.</p> |
| </li> |
| <li> |
| <p>If the (<code>*</code>) is issued in the <code>OBEY</code> command, all files are executed in the current directory. Some of the files in |
| the directory could be binary files. The <code>OBEY</code> command tries to read those binary files and junk or invalid characters are |
| displayed on the console. For example, this command causes invalid characters to be displayed on the console:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY C:\trafci\bin\</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p><code>OBEY</code> detects recursive obey files (for example, an SQL file that calls OBEY on itself) and prevents infinite loops using |
| a max depth environment variable. If no variable is passed to the JVM, the default depth is set to <code>10</code>. To change this depth |
| (for example to a value of <code>20</code>), pass a Java environment variable as follows:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">-Dtrafci.obeydepth=20</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_16">8.20.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>OBEY</code> command runs the script file from the local directory (the same directory where you are running TrafCI):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY ddl.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>OBEY</code> command runs the script file in the specified directory on Windows.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY c:\my_files\ddl.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>OBEY</code> command runs the script file in the specified directory on a Linux or UNIX workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY ./my_files/ddl.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This sample file contains sections to be used in conjunction with the <code>OBEY</code> command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">?section droptable |
| DROP TABLE course ; |
| |
| ?section create |
| CREATE TABLE course ( cno VARCHAR(3) NOT NULL |
| , cname VARCHAR(22) NOT NULL |
| , cdescp VARCHAR(25) NOT NULL |
| , cred INT |
| , clabfee NUMERIC(5,2) |
| , cdept VARCHAR(4) NOT NULL |
| , PRIMARY KEY (cno) |
| ) ; |
| |
| ?section insert |
| INSERT INTO course VALUES ('C11', 'Intro to CS','for Rookies',3, 100, 'CIS') ; |
| INSERT INTO course VALUES ('C22', 'Data Structures','Very Useful',3, 50, 'CIS') ; |
| INSERT INTO course VALUES ('C33', 'Discrete Mathematics', 'Absolutely Necessary',3, 0,'CIS') ; |
| |
| ?section select |
| SELECT * FROM course ; |
| |
| ?section delete |
| PURGEDATA course;</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>To run only the commands in section <code>create</code>, execute the following:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY C:\Command Interfaces\course.sql (create) |
| |
| SQL> ?section create |
| SQL> CREATE TABLE course |
| +>( |
| +> cno VARCHAR(3) NOT NULL, |
| +> cname VARCHAR(22) NOT NULL, |
| +> cdescp VARCHAR(25) NOT NULL, |
| +> cred INT, |
| +> clabfee NUMERIC(5,2), |
| +> cdept VARCHAR(4) NOT NULL, |
| +> PRIMARY KEY (cno) |
| +>) ; |
| |
| --- SQL Operation complete.</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>To run only the commands in the <code>insert</code> section, execute the following:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY C:\Command Interfaces\course.sql (insert) |
| |
| SQL> ?section insert |
| SQL> INSERT INTO course VALUES |
| +> ('C11', 'Intro to CS','For Rookies',3, 100, 'CIS'); |
| |
| --- 1 row(s) inserted. |
| |
| SQL> INSERT INTO course VALUES |
| +> ('C22', 'Data Structures','Very Useful',3, 50, 'CIS'); |
| |
| --- 1 row(s) inserted. |
| |
| SQL> INSERT INTO course VALUES |
| +> ('C33', 'Discrete Mathematics', 'Absolutely Necessary',3, 0, 'CIS'); |
| |
| --- 1 row(s) inserted.</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command executes all files with <code>.sql</code> extension:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY c:\trafci\.sql; |
| SQL> OBEY c:\trafci</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command executes all files beginning with the word <code>"script"</code> and contains one character after the word script |
| and ends with <code>.sql</code> extension. For example: <code>script1.sql</code>, <code>script2.sql</code>, <code>scriptZ.sqland</code> so on.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY C:\trafci\script?.sql</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command executes all files that contain the word <code>"test"</code>. This includes the files that do not end with <code>.sql</code> extension.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY C:\trafci\test</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command executes all files that begin with the word <code>"script"</code> and contains one character after the word <code>"script"</code> and |
| ends with an extension prefixed by a dot. For example: <code>script1.sql</code>, <code>script2.bat</code>, <code>scriptZ.txt</code>, and so on.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY C:\trafci\script?.</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command executes all files that have <code>.txt</code> extension in the current directory, the directory in which the command interface was launched.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY .txt;</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command prompts the user to enter the script filename or a pattern. The default value is <code>*.sql</code>.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY; |
| |
| Enter the script filename [.sql]:</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_prun_command">8.21. PRUN Command</h3> |
| <div class="paragraph"> |
| <p>The <code>PRUN</code> command runs script files in parallel.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_20">8.21.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">PRUN { -d | -defaults } |
| |
| PRUN |
| [ { -sd | -scriptsdir } scriptsdirectory ] |
| [ { -e | -extension } filedirectory ] |
| [ { -ld | -logsdir } log-directory ] |
| [ { -o | -overwrite } {Y | N} |
| [ { -c | -connections } num ]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>-d | -defaults</code></p> |
| <div class="paragraph"> |
| <p>Specify this option to have PRUN use these default settings:</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 30%;"> |
| <col style="width: 70%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Parameter</th> |
| <th class="tableblock halign-left valign-top">Default Setting</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-sd | -scriptsdir</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PRUN</code> searches for the script files in the same directory as the <code>trafci.sh</code> or <code>trafci.cmd</code> file (<code><em>trafci-installation-directory</em>/trafci/bin</code> or |
| <code><em>trafci-installation-directory</em>\trafci\bin</code>).</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-e | -extension</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">The file extension is <code>.sql</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-ld | -logsdir</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PRUN</code> places the log files in the same directory as the script files.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-o | -overwrite</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">No overwriting occurs. <code>PRUN</code> keeps the original information in the log files and appends new information at the end of each file.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>-c | -connections</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PRUN</code> uses two connections.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li> |
| <p><code>{-sd | -scriptsdir} <em>scripts-directory</em></code></p> |
| <div class="paragraph"> |
| <p>In this directory, <code>PRUN</code> processes every file with the specified file extension. If you do not specify a directory or if you specify an |
| invalid directory, an error message occurs, and you are prompted to reenter the directory. Before running <code>PRUN</code>, verify that this directory |
| contains valid script files.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>{-e | -extension} <em>file-extension</em></code></p> |
| <div class="paragraph"> |
| <p>Specify the file extension of the script files. The default is <code>.sql</code>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>{-ld | -logsdir} <em>log-directory</em></code></p> |
| <div class="paragraph"> |
| <p>In this directory, <code>PRUN</code> creates a log file for each script file by appending the <code>.log</code> extension to the name of the script file. If you do |
| not specify a log file directory, <code>PRUN</code> places the log files in the same directory as the script files.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>{-o | -overwrite} {y | n}</code></p> |
| <div class="paragraph"> |
| <p>If you specify <code>y</code>, <code>PRUN</code> overwrites the contents of existing log files. By default, <code>PRUN</code> keeps the original information in the log files and |
| appends new information at the end of each file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>{-c | -connections} <em>num</em></code></p> |
| <div class="paragraph"> |
| <p>Enter a number for the maximum number of connections If you do not specify the maximum number of connections, <code>PRUN</code> uses two connections.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_20">8.21.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If you execute the <code>PRUN</code> command without any arguments, then TrafCI prompts you for the <code>PRUN</code> arguments. If you specify one or more options, |
| then the <code>PRUN</code> command runs without prompting you for more input. In the non-interactive mode, if any options are not specified, <code>PRUN</code> uses the default values.</p> |
| </li> |
| <li> |
| <p>The <code>-d</code> or <code>-defaults</code> option cannot be specified with any other option.</p> |
| </li> |
| <li> |
| <p>The <code>PRUN</code> log files also contain the log end time.</p> |
| </li> |
| <li> |
| <p><code>PRUN</code> does not support the <code>SPOOL</code> or <code>LOG</code> commands. Those commands are ignored in <code>PRUN</code> script files.</p> |
| </li> |
| <li> |
| <p>The environment values from the main session (which are available through the <code>SET</code> commands) are propagated to new sessions started via |
| <code>PRUN</code>. However, prepared statements and parameters are bound only to the main user session.</p> |
| </li> |
| <li> |
| <p>For a summary of all errors and warnings that occurred during the <code>PRUN</code> operation, go to the error subdirectory in the same directory as the log |
| files (for example, <code>C:\log\error</code>) and open the <code>prun.err.log</code> summary file.</p> |
| </li> |
| <li> |
| <p>For details about the errors that occurred during the execution of a script file, open each individual log file (<code><em>script-file</em>.sql.log</code>).</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_17">8.21.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>To use <code>PRUN</code>, enter the <code>PRUN</code> command in the TrafCI session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> PRUN</code></pre> |
| </div> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">Enter as input to stop the current prun session |
| -------------------------------------------------- |
| Enter the scripts directory : c:\ddl_scripts |
| Enter the script file extension[sql] : |
| Enter the logs directory[scripts dir] : c:\log |
| Overwrite the log files (y/n)[n]? : y |
| Enter the number of connections(2-248)[2]: 3</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>After you enter the number of connections, <code>PRUN</code> starts to process the script files and displays this status:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">Status: In Progress.......</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>After executing all the script files, <code>PRUN</code> returns a summary of the operation:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text"> __________________________________________________ |
| PARALLELRUN(PRUN) SUMMARY |
| __________________________________________________ |
| Total files present............................. 3 |
| Total files processed........................... 3 |
| Total queries processed........................ 40 |
| Total errors.................................... 4 |
| Total warnings.................................. 0 |
| Total successes................................ 36 |
| Total connections............................... 3 |
| Total connection failures....................... 0 |
| |
| Please verify the error log file c:\log\error\prun.err.log |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| In the <code>PRUN</code> summary, the <code>Total queries processed</code> is the total number of commands that <code>PRUN</code> processes. |
| Those commands can include SQL statements and commands. The total <code>errors</code>, <code>warnings</code>, and <code>successes</code> also |
| include commands other than SQL statements. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>PRUN</code> command initiates a parallel run operation with the <code>-d</code> option:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> PRUN -d |
| SQL> PRUN -scriptsdir ./prun/sql -e sql -ld ./prun/logs -o y -connections 5 |
| |
| PRUN options are -scriptsdir c:/_trafci/prun |
| -logsdir c:/_trafci/prun/logs |
| -extension sql |
| -overwrite y |
| -connections 5 |
| Status: Complete |
| |
| __________________________________________________ |
| PARALLELRUN(PRUN) SUMMARY |
| __________________________________________________ |
| Total files present............................ 99 |
| Total files processed.......................... 99 |
| Total queries processed....................... 198 |
| Total errors.................................... 0 |
| Total warnings.................................. 0 |
| Total warnings.................................. 0 |
| Total connections............................... 5 |
| Total connection failures....................... 0 |
| |
| =========================================================================== |
| PRUN completed at May 20, 2105 9:33:21 AM |
| ===========================================================================</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>PRUN can be started in non-interactive mode using the <code>-q</code> parameter of <code>trafci.cmd</code> or |
| <code>trafci.sh</code>, thus requiring no input:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">trafci.cmd -h 16.123.456.78 |
| -u user1 -p host1 |
| -q "PRUN -sd c:/_trafci/prun -o y -c 3"</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>PRUN</code> can be started in non-interactive mode from an <code>OBEY</code> file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> OBEY startPrun.txt |
| SQL> PRUN -sd c:/_trafci/prun -ld c:/_trafci/prun/logs -e sql -o y -c 5 |
| |
| PRUN options are -scriptsdir c:/_trafci/prun |
| -logsdir c:/_trafci/prun/logs |
| -extension sql |
| -overwrite yes |
| -connections 5 |
| Status: Complete</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_quit">8.22. QUIT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>QUIT</code> command disconnects from and exits TrafCI.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_21">8.22.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">QUIT [WITH] [status] [IF {condition}]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>status</em></code></p> |
| <div class="paragraph"> |
| <p>is any 1-byte integer. <code><em>status</em></code> is a shell return value, and the range of allowable values is platform dependent.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>condition</em></code></p> |
| <div class="paragraph"> |
| <p>is the same as the condition parameter defined for the <a href="#cmd_if_then">IF…THEN Command</a>. |
| See <a href="#cmd_conditional_parameters">Condition Parameters</a>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_21">8.22.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_18">8.22.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command disconnects from and exits TrafCI, which disappears from the screen:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> QUIT</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>In a script file, the conditional exit command causes the script file to quit running and disconnect from and |
| exit TrafCI when the previously run command returns error code <code>4082</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\errorCode.log |
| SQL> SELECT * FROM employee; |
| SQL> QUIT IF errorcode=4082 |
| SQL> LOG OFF</code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="paragraph"> |
| <p>These results are logged when error code <code>4082</code> occurs:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM employee; |
| |
| **** ERROR[4082] Table, view or stored procedure TRAFODION.USR.EMPLOYEE does not exist or is inaccessible. |
| |
| SQL> QUIT IF errorcode=4082</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_reconnect">8.23. RECONNECT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>RECONNECT</code> command creates a new connection to the Trafodion database using the login credentials of the last successful connection.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_22">8.23.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">RECONNECT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_22">8.23.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>The host name (or IP address) and port number, plus the credentials (user name and password), are used from information previously entered. |
| This is the information specified at launch or when the last <code>CONNECT</code> command was executed.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If TrafCI was invoked with the <code>-noconnect</code> launch parameter, TrafCI prompts you for the values.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_19">8.23.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command creates a new connection to the Trafodion database using the login credentials of the last successful connection:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> RECONNECT |
| |
| Connected to Trafodion</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_repeat">8.24. REPEAT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>REPEAT</code> command re-executes a previous command.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_23">8.24.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">REPEAT [text | [-]number ]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>text</em></code></p> |
| <div class="paragraph"> |
| <p>specifies the text of the most recently executed command. The command must have been executed beginning with <code><em>text</em></code>, |
| but <code><em>text</em></code> need be only as many characters as necessary to identify the command. TrafCI ignores leading blanks.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em class="-">number</em></code></p> |
| <div class="paragraph"> |
| <p>is an integer that identifies a command in the history buffer. If number is negative, it indicates the position of the |
| command in the history buffer relative to the current command; if number is positive, it is the ordinal number of a |
| command in the history buffer.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>The HISTORY command displays the commands or statements in the history buffer. See the <a href="#cmd_history">HISTORY Command</a>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_considerations_23">8.25. Considerations</h3> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>To re-execute the immediately preceding command, enter <code>REPEAT</code> without specifying a number. If you enter more than one |
| command on a line, then the <code>REPEAT</code> command re-executes only the last command on the line.</p> |
| </li> |
| <li> |
| <p>When a command is selected for repeat, and the SQL terminator value has changed since the execution of that command, |
| then TrafCI replaces the SQL terminator in the command with the current SQL terminator value and executes the command.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="sect3"> |
| <h4 id="_examples_20">8.25.1. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Display the previously executed commands and re-execute the second to the last command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HISTORY |
| |
| 1> SET IDLETIMEOUT 0 |
| 2> LOG ON |
| 3> SET SCHEMA persnl; |
| 4> SELECT * FROM employee; |
| 5> SHOW TABLES |
| 6> SELECT * FROM dept; |
| 7> SHOW VIEWS |
| 8> SELECT * FROM emplist; |
| |
| SQL> |
| SQL> REPEAT -2 |
| |
| SHOW VIEWS |
| VIEW NAMES |
| ------------------------------------------------------------- |
| EMPLIST MGRLIST |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Re-execute the fifth command in the history buffer:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> REPEAT 5 |
| |
| SHOW TABLES |
| TABLE NAMES |
| ------------------------------------------------------------- |
| DEPT EMPLOYEE JOB PROJECT |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>Re-execute the <code>SHOW TABLES</code> command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> REPEAT SHOW |
| |
| SHOW TABLES |
| TABLE NAMES |
| ------------------------------------------------------------- |
| DEPT EMPLOYEE JOB PROJECT |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_reset_lasterror">8.26. RESET LASTERROR Command</h3> |
| <div class="paragraph"> |
| <p>The <code>RESET LASTERROR</code> command resets the last error code to 0.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_24">8.26.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">RESET LASTERROR</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_24">8.26.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_21">8.26.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command resets the last error in the current session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM emp; |
| |
| **** ERROR[4082]Object TRAFODION.SCH.EMP does not exist or is inaccessible. |
| |
| SQL> SHOW LASTERROR |
| |
| LASTERROR 4082 |
| |
| SQL> RESET LASTERROR |
| SQL> SHOW LASTERROR |
| |
| LASTERROR 0</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_reset_param">8.27. RESET PARAM Command</h3> |
| <div class="paragraph"> |
| <p>The RESET PARAM command clears all parameter values or a specified parameter value in the current session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_25">8.27.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">RESET PARAM [param-name]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>param-name</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of the parameter for which you specified a value. Parameter names are case-sensitive. For example, |
| the parameter <code>?pn</code> is not equivalent to the parameter <code>?PN</code>. <code><em>param-name</em></code> can be preceded by a |
| question mark (<code>?</code>), such as <code>?<em>param-name</em></code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you do not specify a parameter name, all of the parameter values in the current session are cleared.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_25">8.27.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>To clear several parameter values but not all, you must use a separate <code>RESET PARAM</code> command for each parameter.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_4">8.27.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command clears the setting of the <code>?sal</code> (<code>salary</code>) parameter, and the <code>SET PARAM</code> command resets it to a new value:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> RESET PARAM ?sal + |
| SQL> SET PARAM ?sal 80000.00</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_reset_parameters">Reset the Parameters</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_run">8.28. RUN Command</h3> |
| <div class="paragraph"> |
| <p>The <code>RUN</code> command executes the previously executed SQL statement. This command does not repeat an interface command.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_26">8.28.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">RUN</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_26">8.28.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>The command does not require an SQL terminator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_5">8.28.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command executes the previously executed SELECT statement:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT COUNT(*) FROM persnl.employee; |
| |
| (EXPR) |
| -------------------- |
| 62 |
| |
| --- 1 row(s) selected. |
| |
| SQL> RUN |
| |
| (EXPR) |
| -------------------- |
| 62 |
| |
| --- 1 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_savehist">8.29. SAVEHIST Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SAVEHIST</code> command saves the session history in a user-specified file. The session history consists of a list of the commands that were |
| executed in the TrafCI session before the SAVEHIST command.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_27">8.29.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SAVEHIST file-name [CLEAR]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>file-name</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of a file into which TrafCI stores the session history. If you want the history file to exist outside the local directory where you |
| launch TrafCI (by default, the <code>bin</code> directory), specify the full directory path of the history file. The specified directory must exist |
| before you execute the <code>SAVEHIST</code> command.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>CLEAR</code></p> |
| <div class="paragraph"> |
| <p>instructs TrafCI to clear the contents of the specified file before adding the session history to the file.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_27">8.29.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the specified file already exists, TrafCI appends newer session-history information to the file.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_22">8.29.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command clears the contents of an existing file named <code>history.txt</code> in the local directory (the same directory where you are running TrafCI) |
| and saves the session history in the file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SAVEHIST history.txt CLEAR |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command saves the session history in a file named <code>hist.txt</code> in the specified directory on a Windows workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SAVEHIST c:\log_files\hist.txt |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command saves the session history in a file named <code>hist.txt</code> in the specified directory on a Linux or UNIX workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SAVEHIST ./log_files/hist.txt |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_history">Display Executed Commands</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_colsep">8.30. SET COLSEP Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET COLSEP</code> command sets the column separator and allows you to control the formatting of the result displayed for |
| SQL queries. The <code>SET COLSEP</code> command specifies a delimiter value to use for separating columns in each row of the results. |
| The default delimiter is " "(white space).</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_28">8.30.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET COLSEP [separator]</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_28">8.30.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>The <code>SET COLSEP</code> command has no effect if the markup is set to <code>HTML</code>,<code>XML</code>, or <code>CSV</code>.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_23">8.30.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command specifies the separator as a “|”(pipe):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET COLSEP | |
| SQL> SHOW COLSEP |
| COLSEP "|" |
| SQL> SELECT * FROM employee; |
| |
| EMPNUM|EMPNAME |REGNUM|BRANCHNUM|JOB |
| ------|--------------|------|---------|-------- |
| | 1|ROGER GREEN | 99| 1|MANAGER |
| | 23|JERRY HOWARD | 2| 1|MANAGER |
| | 29|JACK RAYMOND | 1| 1|MANAGER |
| | 32|THOMAS RUDLOFF| 5| 3|MANAGER |
| | 39|KLAUS SAFFERT | 5| 2|MANAGER |
| |
| --- 5 row(s) selected.</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_fetchsize">8.31. SET FETCHSIZE Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET FETCHSIZE</code> command allows you to change the default fetchsize used by JDBC. Setting the value to <code>0</code> sets the |
| fetchsize to the default value used in JDBC.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_29">8.31.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET FETCHSIZE _value_</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>value</em></code></p> |
| <div class="paragraph"> |
| <p>is an integer representing the fetch size as a number of rows. Zero (<code>0</code>) represents the default value of fetch size set in JDBC.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_29">8.31.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>The command does not require an SQL terminator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_24">8.31.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command sets the fetchsize to <code>1</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET FETCHSIZE 1 |
| SQL> SHOW FETCHSIZE |
| |
| FETCHSIZE 1 |
| |
| SQL> SELECT * FROM stream(t1); |
| |
| C1 C2 C3 |
| ------- ------- ------- |
| TEST1 TEST2 TEST3 |
| AAA BBB CCC</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="set_histopt">8.32. SET HISTOPT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET HISTOPT</code> command sets the history option and controls how commands are added to the history buffer. |
| By default, commands within a script file are not added to history. If the history option is set to <code>ALL</code>, |
| then all the commands in the script file are added to the history buffer. If no options are specified, |
| <code>DEFAULT</code> is used.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_30">8.32.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET HISTOPT [ ALL | DEFAULT ]</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_30">8.32.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_25">8.32.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows only the obey commands added to the history buffer.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW HISTOPT |
| |
| HISTOPT DEFAULT [No expansion of script files] |
| |
| SQL> OBEY e:\scripts\nobey\insert2.sql |
| |
| SQL> ?SECTION insert |
| |
| SQL> SET SCHEMA trafodion.sch; |
| |
| --- SQL operation complete. |
| |
| SQL> INSERT INTO course1 VALUES |
| +> ('C11', 'Intro to CS','For Rookies',3, 100,'CIS'); |
| |
| --- 1 row(s) inserted. |
| |
| SQL> INSERT INTO course1 VALUES |
| +> ('C55', 'Computer Arch.','VON Neumann''S Mach.',3, 100, 'CIS'); |
| |
| --- 1 row(s) inserted.</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> HISTORY; |
| |
| 1> SHOW HISTOPT |
| 2> OBEY e:\scripts\nobey\insert2.sql</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows all the commands added to the history buffer.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET HISTOPT ALL |
| SQL> OBEY e:\scripts\nobey\insert2.sql |
| |
| ?SECTION insert |
| |
| SQL> set schema trafodion.sch; |
| |
| --- SQL operation complete. |
| |
| SQL> INSERT INTO course1 VALUES |
| +> ('C11','Intro to CS','For Rookies',3, 100, 'CIS'); |
| |
| ---1 row(s) inserted. |
| |
| SQL> INSERT INTO course1 VALUES |
| +> ('C55','Computer Arch.','Von Neumann''s Mach.',3,100, 'CIS'); |
| |
| ---1 row(s) inserted. |
| |
| SQL> HISTORY; |
| |
| 1> SHOW HISTOPT |
| 2> OBEY e:\scripts\nobey\insert2.sql |
| 3> HISTORY; |
| 4> SET HISTOPT ALL |
| 5> SET SCHEMA trafodion.sch; |
| 6> INSERT INTO course1 VALUES |
| ('C11','Intro to CS','For Rookies',3, 100, 'CIS'); |
| 7> INSERT INTO course1 VALUES |
| ('C55','Computer Arch.','Von Neumann''s MACH.',3,100, 'CIS');</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_idletimeout">8.33. SET IDLETIMEOUT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET IDLETIMEOUT</code> command sets the idle timeout value for the current session. The idle timeout value |
| of a session determines when the session expires after a period of inactivity. The default is <code>30 minutes</code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_31">8.33.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET IDLETIMEOUT value</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>value</em></code></p> |
| <div class="paragraph"> |
| <p>is an integer representing the idle timeout value in minutes. Zero represents an infinite amount of time, meaning that |
| the session never expires.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_31">8.33.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If you execute this command in a script file, it affects the session in which the script file runs. You can specify |
| this command in <code>PRUN</code> script files. However, running this command from a <code>PRUN</code> script file does not affect the idle |
| timeout value for the current session.</p> |
| </li> |
| <li> |
| <p>To reset the default timeout value, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET IDLETIMEOUT 30</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_26">8.33.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command sets the idle timeout value to four hours:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET IDLETIMEOUT 240</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command sets the idle timeout value to an infinite amount of time so that the session never expires:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET IDLETIMEOUT 0</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>To reset the idle timeout to the default, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET IDLETIMEOUT 30 |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_idle_timeout">Set and Show Session Idle Timeout Value</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_list_count">8.34. SET LIST_COUNT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET LIST_COUNT</code> command sets the maximum number of rows to be returned by <code>SELECT</code> statements that are executed |
| after this command. The default is zero, which means that all rows are returned.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_32">8.34.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET LIST_COUNT num-rows</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>num-rows</em></code></p> |
| <div class="paragraph"> |
| <p>is a positive integer that specifies the maximum number of rows of data to be displayed by <code>SELECT</code> statements that |
| are executed after this command. Zero means that all rows of data are returned.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_32">8.34.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>To reset the number of displayed rows, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET LIST_COUNT 0</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_27">8.34.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command specifies that the number of rows to be displayed by <code>SELECT</code> statements is five:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET LIST_count 5 |
| SQL> SELECT empnum, first_name, last_name FROM persnl.employee ORDER BY empnum; |
| |
| EMPNUM FIRST_NAME LAST_NAME |
| ------ --------------- -------------------- |
| 1 ROGER GREEN |
| 23 JERRY HOWARD |
| 29 JANE RAYMOND |
| 32 THOMAS RUDLOFF |
| 39 KLAUS SAFFERT |
| |
| --- 5 row(s) selected. LIST_COUNT was reached. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command resets the number of displayed rows to all rows:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET LIST_COUNT 0 |
| SQL> SELECT empnum, first_name, last_name |
| +> FROM persnl.employee |
| +> ORDER BY empnum; |
| |
| EMPNUM FIRST_NAME LAST_NAME |
| ------ --------------- -------------------- |
| 1 ROGER GREEN |
| 23 JERRY HOWARD |
| 29 JANE RAYMOND |
| 32 THOMAS RUDLOFF |
| 39 KLAUS SAFFERT |
| 43 PAUL WINTER |
| 65 RACHEL MCKAY |
| ... |
| 995 Walt Farley |
| |
| --- 62 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_markup">8.35. SET MARKUP Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET MARKUP</code> command sets the markup format and controls how results are displayed by TrafCI.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_33">8.35.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET MARKUP [ RAW | HTML | XML | CSV | COLSEP ]</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The supported options enable results to be displayed in <code>XML</code>, <code>HTML</code>, <code>CSV</code> (Comma Separated Values), and <code>COLSEP</code> format. |
| The default format is <code>RAW</code>.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_33">8.35.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>If the <code>MARKUP</code> format is <code>CSV</code> or <code>COLSEP</code>, the column header information and status messages are not displayed.</p> |
| </li> |
| <li> |
| <p>For the <code>XML</code> and <code>HTML</code> markup format, the syntax and interface errors is consistent <code>XML</code> |
| and <code>HTML</code> markup is displayed.</p> |
| </li> |
| <li> |
| <p>For <code>XML</code> markup, any occurrence of <code>]]></code> that appear in the error message or invalid query are replaced with <code>]]></code>.</p> |
| </li> |
| <li> |
| <p>When error messages are output as <code>HTML</code> markup, both the <code>></code> (greater than) and <code><</code> (less than) symbols are |
| replaced with their escaped versions: <code>></code> and <code><</code>, respectively. An example of the formatted error messages are show below.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_28">8.35.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command specifies results be displayed in <code>HTML</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP HTML |
| SQL> SELECT c.custnum, c.custnum, ordernum, order_date |
| +> FROM customer c, orders o where c.custnum=o.custnum; |
| |
| <TABLE> |
| <!--SELECT c.custnum, c.custname,ordernum,order_date |
| FROM customer c, orders o where c.custnum=o.custnum;--> |
| <tr> |
| <th>CUSTNUM</th> |
| <th>CUSTNAME</th> |
| <th>ORDERNUM</th> |
| <th>ORDER_DATE</th> |
| </tr> |
| <tr> |
| <td>143</td> |
| <td>STEVENS SUPPLY</td> |
| <td>700510</td> |
| <td>2105-05-01</td> |
| </tr> |
| <tr> |
| <td>3333</td> |
| <td>NATIONAL UTILITIES</td> |
| <td>600480</td> |
| <td>2105-05-12</td> |
| </tr> |
| <tr> |
| <td>7777</td> |
| <td>SLEEP WELL HOTELS</td> |
| <td>100250</td> |
| <td>2105-01-23</td> |
| </tr> |
| <!-- --- 3 row(s) selected.--> |
| </TABLE></code></pre> |
| </div> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </li> |
| </ul> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT c.custnum, c.custname,ordernum,order_date, |
| +> FROM customer c, orders o where c.custnum=o.custnum; |
| |
| <TABLE> |
| <!-- SELECT c.custnum, c.custname,ordernum,order_date, |
| FROM customer c, orders o where c.custnum=o.custnum;--> |
| <tr> |
| <th>Error Id</th> |
| <th>Error Code</th> |
| <th>Error Message</th> |
| </tr> |
| <tr> |
| <td>1</td> |
| <td>4082</td> |
| <td>Object TRAFODION.NVS.CUSTOMER does not exist or is inaccessible.</td> |
| </tr> |
| </TABLE></code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>To set the application to format output as <code>HTML</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP HTML</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>HTML formatted error message example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP <invalid> |
| |
| <?xml version="1.0"?> |
| <Results> |
| <Query> |
| <![CDATA[set markup <invalid ]]> |
| </Query> |
| <ErrorList> |
| <Error id="1"> |
| <ErrorCode>NVCI001</ErrorCode> |
| <ErrorMsg> <![CDATA[ |
| ERROR: A syntax error occurred at or before: |
| set markup <invalid> |
| ^ ]] |
| </ErrorMsg> |
| </ErrorList> |
| </Results></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command specifies results be displayed in <code>CSV</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP CSV |
| SQL> SELECT c.custnum, c.custnum, ordernum, order_date |
| +> FROM customer c,orders o where c.custnum=o.custnum; |
| |
| 143,STEVENS SUPPLY ,700510,2105-05-01 |
| 3333,NATIONAL UTILITIES,600480,2105-05-12 |
| 7777,SLEEPWELL HOTELS ,100250,2105-01-23 |
| 324,PREMIER INSURANCE ,500450,2105-04-20 |
| 926,METALL-AG. ,200300,2105-02-06 |
| 123,BROWN MEDICAL CO ,200490,2105-03-19 |
| 123,BROWN MEDICAL CO ,300380,2105-03-19 |
| 543,FRESNO STATE BANK ,300350,2105-03-03 |
| 5635,ROYAL CHEMICALS ,101220,2105-05-21 |
| 21,CENTRAL UNIVERSITY,200320,2105-02-17 |
| 1234,DATASPEED ,100210,2105-04-10 |
| 3210,BESTFOOD MARKETS ,800660,2105-05-09</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command specifies results be displayed in <code>XML</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP XML |
| SQL> SELECT * FROM author |
| |
| <?xml version="1.0"?> |
| <Results> |
| <Query> |
| <![CDATA[select from author;]]> |
| </Query> |
| <rowid="1"> |
| <AUTHORID>91111</AUTHORID> |
| <AUTHORNAME>Bjarne Stroustrup</AUTHORNAME> |
| </row> |
| <rowid="2"> |
| <AUTHORID>444444</AUTHORID> |
| <AUTHORNAME>John Steinbeck</AUTHORNAME> |
| </row> |
| <rowid="3"> |
| <AUTHORID>2323423</AUTHORID> |
| <AUTHORNAME>Irwin Shaw</AUTHORNAME> |
| </row> |
| <rowid="4"> |
| <AUTHORID>93333</AUTHORID> |
| <AUTHORNAME>Martin Fowler</AUTHORNAME> |
| </row> |
| <rowid="5"> |
| <AUTHORID>92222</AUTHORID> |
| <AUTHORNAME>Grady Booch</AUTHORNAME> |
| </row> |
| <rowid="6"> |
| <AUTHORID>84758345</AUTHORID> |
| <AUTHORNAME>Judy Blume</AUTHORNAME> |
| </row> |
| <rowid="7"> |
| <AUTHORID>89832473</AUTHORID> |
| <AUTHORNAME>Barbara Kingsolver</AUTHORNAME> |
| </row> |
| <Status> <![CDATA[-- 7 row(s) selected .]]></Status> |
| </Results></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>To set the application to format output as <code>XML</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP XML</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p><code>XML</code> formatted error message examples:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET MARKUP <]]> |
| |
| <?xml version="1.0"?> |
| <Results> |
| <Query> |
| <![CDATA[set markup <]]&#62; ]]>> |
| </Query> |
| <ErrorList> |
| <Error id="1"> |
| <ErrorCode>UNKNOWN ERROR CODE</ErrorCode |
| <ErrorMessage> <![CDATA[ |
| ERROR: A syntax error occurred at or before: |
| set markup <]]&#62;> |
| ^ ]]<> |
| </ErrorMessage> |
| </ErrorList> |
| </Results></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays <code>CSV</code> like output using the <code>COLSEP</code> value as a separator.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET COLSEP | |
| SQL> SET MARKUP COLSEP |
| SQL> SELECT * FROM employee; |
| |
| 32|THOMAS |RUDLOFF |2000|100|138000.40 |
| 39|KLAUS |SAFFERT |3200|100|75000.00 |
| 89|PETER |SMITH |3300|300|37000.40 |
| 29|JANE |RAYMOND |3000|100|136000.00 |
| 65|RACHEL |MCKAY |4000|100|118000.00 |
| 75|TIM |WALKER |3000|300|320000.00 |
| 11|ROGER |GREEN |9000|100|175500.00 |
| 93|DONALD |TAYLOR |3100|300|33000.00</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_param">8.36. SET PARAM Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET PARAM</code> command associates a parameter name with a parameter value in the current session. |
| The parameter name and value are associated with one of these parameter types:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>Named parameter (represented by <code>?<em>param-name</em></code>) in a DML statement or in a prepared SQL statement</p> |
| </li> |
| <li> |
| <p>Unnamed parameter (represented by <code>?</code>) in a prepared SQL statement only</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>A prepared statement is one that you SQL compile by using the PREPARE statement. |
| For more information about PREPARE, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>After running <code>SET PARAM</code> commands in the session:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You can specify named parameters (<code>?<em>param-name</em></code>) in a DML statement.</p> |
| </li> |
| <li> |
| <p>You can execute a prepared statement with named parameters by using the <code>EXECUTE</code> statement without a <code>USING</code> clause.</p> |
| </li> |
| <li> |
| <p>You can execute a prepared statement with unnamed parameters by using the <code>EXECUTE</code> statement with a <code>USING</code> clause |
| that contains literal values and/or a list of the named parameters set by <code>SET PARAM</code>.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>EXECUTE</code> statement substitutes parameter values for the parameters in the prepared statement. For more information about <code>EXECUTE</code>, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="sect3"> |
| <h4 id="_syntax_34">8.36.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET PARAM param-name [UTF8] param-value</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>param-name</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of the parameter for which a value is specified. Parameter names are case-sensitive. |
| For example, the parameter <code>?pn</code> is not equivalent to the parameter <code>?PN</code>. <code><em>param-name</em></code> can be |
| preceded by a question mark (<code>?</code>), such as <code>?<em>param-name</em></code>.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>UTF8</code></p> |
| <div class="paragraph"> |
| <p>specifies that a character string specified for the parameter value, <code><em>param-value</em></code>, uses the |
| <code>UTF8</code> character set. If the character string is in <code>UTF8</code> format, it must be prefixed by <code>UTF8</code>.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>param-value</em></code></p> |
| <div class="paragraph"> |
| <p>is a numeric or character literal that specifies the value for the parameter. If you do not specify a value, |
| TrafCI returns an error.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code><em>param-value</em></code> is a character literal and the target column type is a character string, you do not have |
| to enclose the value in single quotation marks. Its data type is determined from the data type of the column |
| to which the literal is assigned. Character strings specified as parameter values are always case-sensitive |
| even if they are not enclosed in quotation marks. If the character string is in <code>UTF8</code> format, it must |
| be prefixed by <code>UTF8</code>.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_34">8.36.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>Use separate <code>SET PARAM</code> commands to name and assign values to each unique parameter in a prepared SQL |
| statement before running the <code>EXECUTE</code> statement.</p> |
| </li> |
| <li> |
| <p>Parameter names are case-sensitive. If you specify a parameter name in lowercase in the <code>SET PARAM</code> command, |
| you must specify it in lowercase in other statements, such as DML statements or <code>EXECUTE</code>.</p> |
| </li> |
| <li> |
| <p>The name of a named parameter (<code>?<em>param-name</em></code>) in a DML statement must be identical to the parameter name |
| (<code><em>param-name</em></code>) that you specify in a <code>SET PARAM</code> command.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_29">8.36.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command sets a value for the <code>?sal</code> (<code>salary</code>) parameter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?sal 40000.00</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command sets a character string value, <code>GREEN</code>, for the <code>?lastname</code> parameter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?lastname GREEN</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>These commands set values for named parameters in a subsequent <code>SELECT</code> statement:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?sal 80000.00 |
| SQL> SET PARAM ?job 100 |
| SQL> SELECT * FROM persnl.employee WHERE salary = ?sal AND jobcode = ?job; |
| |
| EMPNUM FIRST_NAME LAST_NAME DEPTNUM JOBCODE SALARY |
| ------ --------------- -------------------- ------- ------- ---------- |
| 72 GLENN THOMAS 3300 100 80000.00 |
| |
| --- 1 row(s) selected. |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| <div class="admonitionblock note"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-note" title="Note"></i> |
| </td> |
| <td class="content"> |
| The names of the named parameters, <code>?sal</code> and <code>?job</code>, in the <code>SELECT</code> statement are |
| identical to the parameter <code>names</code>, <code>sal</code> and <code>job</code>, in the <code>SET PARAM</code> command. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </li> |
| <li> |
| <p>This command sets a character string value, <code>Peña</code>, which is in <code>UTF8</code> format, |
| for the <code>?lastname</code> parameter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?lastname UTF8'Pe&#241;a'</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command sets a character string value, which uses the <code>UTF8</code> character set and is in |
| hexadecimal notation, for the <code>?lastname</code> parameter:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PARAM ?lastname UTF8x'5065266e74696c64653b61'</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_set_parameters">Set Parameters</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_prompt">8.37. SET PROMPT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET PROMPT</code> command sets the prompt of the current session to a specified string and/or to the session variables, |
| which start with <code>%</code>. The default prompt is <code>SQL></code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_35">8.37.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET PROMPT [string] [%USER] [%SERVER] [%SCHEMA]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>string</em></code></p> |
| <div class="paragraph"> |
| <p>is a string value to be displayed as the prompt. The string may contain any characters. Spaces are allowed if you enclose |
| the string in double quotes (<code>"</code>). If you do not enclose the string in double quotes, the prompt is displayed in uppercase.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>%USER</code></p> |
| <div class="paragraph"> |
| <p>displays the session user name as the prompt.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>%SERVER</code></p> |
| <div class="paragraph"> |
| <p>displays the session host name and port number as the prompt.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>%SCHEMA</code></p> |
| <div class="paragraph"> |
| <p>displays the session schema as the prompt.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_35">8.37.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>To reset the default prompt, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET PROMPT</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_30">8.37.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This <code>SET PROMPT</code> command sets the SQL prompt to <code>ENTER></code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PROMPT Enter> |
| ENTER></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>To reset the SQL prompt to the default, enter this <code>SET PROMPT</code> command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">ENTER> SET PROMPT + |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the session user name for the prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PROMPT %user> |
| user1></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the session host name and port number for the prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PROMPT %server> |
| sqws135.houston.host.com:22900></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the session schema for the prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PROMPT "Schema %schema:" |
| Schema USR:</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays multiple session variables:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET PROMPT %USER@%SCHEMA> user1@USR> |
| user1@USR>set prompt %SERVER:%USER> |
| sqws135.houston.host.com:22900:user1> |
| sqws135.houston.host.com:22900:user1> SET PROMPT "%schema CI> " |
| USR CI></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_customize_prompt">Customize Standard Prompt</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_set_sqlprompt_command">8.38. SET SQLPROMPT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET SQLPROMPT</code> command sets the SQL prompt of the current session to |
| a specified string. The default is <code>SQL></code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_36">8.38.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET SQLPROMPT [string] [%USER] [%SERVER] [%SCHEMA]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>string</em></code></p> |
| <div class="paragraph"> |
| <p>is a string value to be displayed as the SQL prompt. The string may contain any characters. |
| Spaces are allowed if you enclose the string in double quotes. If you do not enclose the string |
| in double quotes (<code>"</code>), the prompt is displayed in uppercase.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>%USER</code></p> |
| <div class="paragraph"> |
| <p>displays the session user name as the prompt.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>%SERVER</code></p> |
| <div class="paragraph"> |
| <p>displays the session host name and port number as the prompt.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>%SCHEMA</code></p> |
| <div class="paragraph"> |
| <p>displays the session schema as the prompt.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_36">8.38.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>To reset the default SQL prompt, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET SQLPROMPT</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_31">8.38.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command sets the SQL prompt to <code>ENTER></code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLPROMPT Enter> |
| ENTER></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>To reset the SQL prompt to the default, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">ENTER> SET SQLPROMPT |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the session user name for the prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLPROMPT %user> |
| user1></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the session host name and port number for the prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLPROMPT %server> |
| sqws135.houston.host.com:22900></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the session schema for the prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLPROMPT "Schema %schema:" |
| Schema USR:</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays multiple session variables:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLPROMPT %USER@%SCHEMA> |
| user1@USR> |
| |
| SQL> SET SQLPROMPT %SERVER:%USER> |
| sqws135.houston.host.com:22900:user1> |
| sqws135.houston.host.com:22900:user1> SET SQLPROMPT "%schema CI> " |
| USR CI></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_customize_prompt">Customize Standard Prompt</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_sqlterminator">8.39. SET SQLTERMINATOR Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET SQLTERMINATOR</code> command sets the SQL statement terminator of the current session. |
| The default is a semicolon (<code>;</code>).</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_37">8.39.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET SQLTERMINATOR string</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>string</em></code></p> |
| <div class="paragraph"> |
| <p>is a string value for the SQL terminator. The string may contain any characters except spaces. |
| Spaces are disallowed even if you enclose the string in double quotes. Lowercase and uppercase |
| characters are accepted, but the SQL terminator is always shown in uppercase.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_37">8.39.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>Do not include a reserved word as an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If you execute this command in a script file, it affects not only the SQL statements in the script |
| file but all subsequent SQL statements that are run in the current session. If you set the SQL terminator |
| in a script file, reset the default terminator at the end of the script file.</p> |
| </li> |
| <li> |
| <p>To reset the default SQL terminator (<code>;</code>), enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET SQLTERMINATOR ;</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_32">8.39.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command sets the SQL terminator to a period (<code>.</code>):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLTERMINATOR .</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command sets the SQL terminator to a word, <code>go</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLTERMINATOR go</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>This query ends with the new terminator, <code>go</code>:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM persnl.employee go</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>To reset the SQL terminator to the default, enter this command:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET SQLTERMINATOR ;</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_statistics">8.40. SET STATISTICS Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET STATISTICS</code> command automatically retrieves the statistics information for a query being executed. |
| The results returned are the same as would have been returned if the <code>GET STATISTICS</code> command was executed. |
| The default is <code>OFF</code> which means the statistics information is not automatically printed for any queries.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_38">8.40.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET STATISTICS { ON | OFF }</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_38">8.40.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_33">8.40.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows the default output format as <code>PERTABLE</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET STATISTICS ON |
| SQL> SELECT * FROM job; |
| |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER |
| 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 11 row(s) selected. |
| |
| Start Time 2105/05/18 21:45:34.082329 |
| End Time 2105/05/18 21:45:34.300265 |
| Elapsed Time 00:00:00.217936 |
| Compile Time 00:00:00.002423 |
| Execution Time 00:00:00.218750 |
| |
| Table Name Records Records Disk Message Message Lock Lock Disk Process |
| Accessed Used I/Os Count Bytes Escl Wait Busy Time |
| TRAFODION.TOI.JOB |
| 2 2 0 4 15232 0 0 363 |
| |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information on the STATISTICS command, see the |
| <a href="http://trafodion.apache.org/docs/sql_reference/index.html"><em>Trafodion SQL Reference Manual</em></a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_time">8.41. SET TIME Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET TIME</code> command causes the local time of the client workstation to be displayed as part of the |
| interface prompt. By default, the local time is not displayed in the interface prompt.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_39">8.41.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET TIME { ON[12H] | OFF }</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>ON</code></p> |
| <div class="paragraph"> |
| <p>specifies that the local time be displayed as part of the prompt.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>OFF</code></p> |
| <div class="paragraph"> |
| <p>specifies that the local time not be displayed as part of the prompt. <code>OFF</code> is the default.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_39">8.41.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>The default is a 24-hour military style display. The additional argument of <code>12h</code> allows |
| the time to be displayed in a 12-hour AM/PM style.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_34">8.41.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command causes the local time to be displayed in the SQL prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIME ON |
| 14:17:17 SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command causes the local time to be displayed in 12-hour AM/PM style in the SQL prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIME ON 12H |
| 2:17:17 PM SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command turns off the local time in the SQL prompt:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">2:17:17 PM SQL> SET TIME OFF |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_customize_prompt">Customize the Standard Prompt</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_timing">8.42. SET TIMING Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SET TIMING</code> command causes the elapsed time to be displayed after each SQL statement executes. |
| This command does not cause the elapsed time of interface commands to be displayed. By default, the |
| elapsed time is <code>off</code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_40">8.42.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SET TIMING { ON | OFF }</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>ON</code></p> |
| <div class="paragraph"> |
| <p>specifies the elapsed time be displayed after each SQL statement executes.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>OFF</code></p> |
| <div class="paragraph"> |
| <p>specifies that the elapsed time not be displayed after each SQL statement executes. <code>OFF</code> is the default.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_40">8.42.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>The elapsed time value includes compile and execution time plus any network I/O time and client-side processing time.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_35">8.42.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the elapsed time of SQL statements:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING ON</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command turns off the elapsed time:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING OFF</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_display_elapsed_time">Display the Elapsed Time</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_activitycount">8.43. SHOW ACTIVITYCOUNT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW ACTIVITYCOUNT</code> command provides an alias for <code>SHOW RECCOUNT</code>. |
| <code>ACTIVITYCOUNT</code> is an alias for <code>RECCOUNT</code>. For more information, see the <a href="#cmd_reccount">SHOW RECCOUNT Command</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_41">8.43.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW ACTIVITYCOUNT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_36">8.43.2. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows the record count of the previous executed SQL statement:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ACTIVITYCOUNT |
| |
| ACTIVITYCOUNT 0</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_alias">8.44. SHOW ALIAS Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW ALIAS</code> command displays all or a set of aliases available in the current TrafCI session. If a pattern is specified, |
| then all aliases matching the pattern are displayed. By default, all aliases in the current session are displayed.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_42">8.44.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW ALIAS [ alias-name | wild-card-pattern ]</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code><em>alias-name</em></code></p> |
| <div class="paragraph"> |
| <p>is any alias name that is used with the <code>ALIAS</code> command. See <a href="#cmd_alias">ALIAS Command</a>.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>wild-card-pattern</em></code></p> |
| <div class="paragraph"> |
| <p>is a character string used to search for and display aliases with names that match the character string. <code><em>wild-card-pattern</em></code> |
| matches an uppercase string unless you enclose it within double quotes. To look for similar values, specify only part of the |
| characters of <code><em>wild-card-pattern</em></code> combined with these wild-card characters.</p> |
| </div> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 10%;"> |
| <col style="width: 90%;"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>%</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use a percent sign (<code>%</code>) to indicate zero or more characters of any type.<br> |
| <br> |
| For example, <code>%art%</code> matches <code>SMART</code>, <code>ARTIFICIAL</code>, and <code>PARTICULAR</code> but not smart or Hearts. <code>"%art%"</code> matches <code>smart</code> and <code>Hearts</code> |
| but not <code>SMART</code>, <code>ARTIFICIAL</code>, or <code>PARTICULAR</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>*</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use an asterisk (<code><strong></code>) to indicate zero or more characters of any type.<br> |
| <br> |
| For example, <code>*art</strong></code> matches <code>SMART</code>, <code>ARTIFICIAL</code>, and <code>PARTICULAR</code> but not <code>smart</code> or <code>Hearts</code>. |
| <code>"<strong>art</strong>"</code> matches <code>smart</code> and <code>Hearts</code> but not <code>SMART</code>, <code>ARTIFICIAL</code>, or <code>PARTICULAR</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>_</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use an underscore (<code>_</code>) to indicate any single character.<br> |
| <br> |
| For example, <code>boo_</code> matches <code>BOOK</code> and <code>BOOT</code> but not <code>BOO</code> or <code>BOOTS</code>. <code>"boo_"</code> matches <code>book</code> and <code>boot</code> but not <code>boo</code> or <code>boots</code>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>?</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Use a question mark (<code>?</code>) to indicate any single character.<br> |
| <br> |
| For example, <code>boo?</code> matches <code>BOOK</code> and <code>BOOT</code> but not <code>BOO</code> or <code>BOOTS</code>. <code>"boo?"</code> matches <code>book</code> and <code>boot</code> but not <code>boo</code> or <code>boots</code>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_41">8.44.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_37">8.44.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays a list of the available aliases:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ALIAS |
| |
| .OS AS LH |
| .GOTO AS GOTO |
| USE AS SET SCHEMA</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the <code>.GOTO</code> alias:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ALIAS .GOTO |
| |
| .GOTO AS GOTO</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the <code>.FOO</code> alias:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ALIAS .FOO |
| |
| No aliases found.</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays all aliases beginning with the letter <code>S</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ALIAS S* |
| |
| SEL AS SELECT |
| SHOWTIME AS SHOW TIME |
| ST AS SHOW TABLES</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_aliases">8.45. SHOW ALIASES Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW ALIASES</code> command displays all the aliases available in the current TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_43">8.45.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW ALIASES</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_42">8.45.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_38">8.45.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays all the aliases in the current TrafCI session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ALIASES |
| |
| .OS AS LH |
| .GOTO AS GOTO |
| USE AS SET SCHEMA</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_catalog">8.46. SHOW CATALOG Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW CATALOG</code> command displays the current catalog of the TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_44">8.46.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW CATALOG</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_43">8.46.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_6">8.46.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that the current catalog of the session is TRAFODION:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW CATALOG |
| |
| CATALOG TRAFODION</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_colsep">8.47. SHOW COLSEP Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW COLSEP</code> command displays the value of the column separator for the current TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_45">8.47.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW COLSEP</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_44">8.47.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_39">8.47.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the column separator.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW COLSEP |
| |
| COLSEP " " |
| |
| SQL> SET COLSEP |
| SQL> SHOW COLSEP |
| |
| COLSEP ""</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the column separator.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW COLSEP |
| |
| COLSEP " " |
| |
| SQL> SET COLSEP |
| SQL> SHOW COLSEP |
| |
| COLSEP ""</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_errorcode">8.48. SHOW ERRORCODE Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW ERRORCODE</code> command is an alias for the <code>SHOW LASTERROR</code> command. <code>ERRORCODE</code> is an alias for <code>LASTERROR</code>. For more information, see |
| <a href="#cmd_show_lasterror">SHOW LASTERROR Command</a>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_46">8.48.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW ERRORCODE</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_40">8.48.2. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the error of the last SQL statement that was executed:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW ERRORCODE |
| |
| ERRORCODE 29481</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_fetchsize">8.49. SHOW FETCHSIZE Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW FETCHSIZE</code> command displays the fetch size value for the current TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_47">8.49.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW FETCHSIZE</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_45">8.49.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_41">8.49.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>These commands display the fetch size in the current TrafCI session, set the fetch size to a new value, and then redisplay the fetch size:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW FETCHSIZE |
| |
| FETCHSIZE 0 [Default] |
| |
| SQL> SET FETCHSIZE 1 |
| SQL> SHOW FETCHSIZE |
| |
| FETCHSIZE 1</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_histopt">8.50. SHOW HISTOPT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW HISTOPT</code> command displays the value that has been set for the history option.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_48">8.50.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW HISTOPT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_46">8.50.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_42">8.50.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the value set for the history option:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW HISTOPT |
| |
| HISTOPT DEFAULT [No expansion of script files] |
| |
| SQL> SET HISTOPT ALL |
| SQL> SHOW HISTOPT |
| |
| HISTOPT ALL</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_idletimeout">8.51. SHOW IDLETIMEOUT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW IDLETIMEOUT</code> command displays the idle timeout value of the current TrafCI session. The idle timeout |
| value of a session determines when the session expires after a period of inactivity. |
| The default is <code>30 minutes</code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_49">8.51.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW IDLETIMEOUT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_47">8.51.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_43">8.51.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that the idle timeout value of the session is 30 minutes, which is the default:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW IDLETIMEOUT |
| |
| IDLETIMEOUT 30 min(s) |
| |
| Elapsed time:00:00:00:078</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command shows that the idle timeout value of the session is four hours:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW IDLETIMEOUT |
| |
| IDLETIMEOUT 240 min(s)</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command shows that the idle timeout value is an infinite amount of time, meaning that the session never expires:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW IDLETIMEOUT |
| |
| IDLETIMEOUT 0 min(s) [Never Expires]</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command displays the elapsed time information because <code>SET TIMING</code> command is enabled:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING ON |
| SQL> SHOW IDLETIMEOUT |
| |
| IDLETIMEOUT 0 min(s) [Never Expires] |
| |
| Elapsed time:00:00:00:078</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_idle_timeout">Set and Show Session Idle Timeout Value</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_lasterror">8.52. SHOW LASTERROR Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW LASTERROR</code> command displays the error of the last SQL statement that was executed. |
| If the query was successful, then <code>0</code> is returned; otherwise an SQL error code is returned.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_50">8.52.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW LASTERROR</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_48">8.52.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_44">8.52.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows the last error in the current session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM emp; |
| |
| **** ERROR[4082]Object TRAFODION.SCH.EMP does not exist or is inaccessible. |
| |
| SQL> SHOW LASTERROR |
| |
| LASTERROR 4082</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_list_count">8.53. SHOW LIST_COUNT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW LIST_COUNT</code> command displays the maximum number of rows to be returned by <code>SELECT</code> statements in the |
| current TrafCI session. The default is <code>zero</code>, which means that all rows are returned.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_51">8.53.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW LIST_COUNT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_49">8.53.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_45">8.53.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that <code>SELECT</code> statements return all rows in the current session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW LIST_COUNT |
| |
| LISTCOUNT 0 [All Rows] |
| |
| Elapsed time:00:00:00:078</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command shows that the maximum number of rows to be displayed by <code>SELECT</code> statements in the session is five:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET LIST_COUNT 5 |
| SQL> SHOW LIST_COUNT |
| |
| LIST_COUNT 5 |
| |
| Elapsed time:00:00:00:078</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_markup">8.54. SHOW MARKUP Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW MARKUP</code> command displays the value set for the markup option.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_52">8.54.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW MARKUP</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_50">8.54.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_46">8.54.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the value set for the markup option:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW MARKUP |
| |
| MARKUP RAW |
| |
| Elapsed time:00:00:00:078</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_param">8.55. SHOW PARAM Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW PARAM</code> command displays the parameters that are set in the current TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_53">8.55.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW PARAM</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_51">8.55.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_7">8.55.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that parameters that are set for the current session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW PARAM |
| |
| lastname GREEN |
| dn 1500 |
| sal 40000.00</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command shows that when no parameters exist, the <code>SHOW PARAM</code> command displays an error message:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW PARAM |
| |
| No parameters found.</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, <a href="#interactive_display_session_parameters">Display Session Parameters</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_prepared">8.56. SHOW PREPARED Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW PREPARED</code> command displays the prepared statements in the current TrafCI session. |
| If a pattern is specified, then all prepared statements matching the prepared statement name |
| pattern are displayed. By default, all prepared statements in the current session are displayed.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_54">8.56.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW PREPARED</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_52">8.56.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_47">8.56.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows all the prepared statements, by default:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW PREPARED |
| |
| S1 |
| SELECT * FROM t1 |
| S2 |
| SELECT * FROM student |
| T1 |
| SELECT * FROM test123 |
| |
| SQL> SHOW PREPARED s% |
| |
| S1 |
| SELECT * FROM t1 |
| S2 |
| SELECT * FROM student |
| |
| SQL> SHOW PREPARED t% |
| |
| T1 |
| SELECT * FROM test123</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_reccount">8.57. SHOW RECCOUNT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW RECCOUNT</code> command displays the record count of the previously executed SQL statement. If the previously |
| executed command was an interface command, then TrafCI returns zero.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_55">8.57.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW RECCOUNT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_53">8.57.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not need an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_48">8.57.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the record count of the SQL statement that was executed last:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SELECT * FROM employee; |
| SQL> SHOW RECCOUNT |
| |
| RECCOUNT 62</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_remoteprocess">8.58. SHOW REMOTEPROCESS Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW REMOTEPROCESS</code> command displays the process name of the DCS server that is handling the current connection.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_56">8.58.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW REMOTEPROCESS</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_54">8.58.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not need an SQL terminator.</p> |
| </li> |
| <li> |
| <p>The command does not need an SQL terminator.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_8">8.58.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the process name, <code>\g4t3028.houston.host.com:0.$Z0000M2</code>, of the DCS server that is handling |
| the current connection:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW REMOTEPROCESS |
| |
| REMOTE PROCESS \g4t3028.houston.host.com:0.$Z0000M2 |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_schema">8.59. SHOW SCHEMA Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW SCHEMA</code> command displays the current schema of the TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_57">8.59.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW SCHEMA</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_55">8.59.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_9">8.59.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that the current schema of the session is <code>PERSNL</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW SCHEMA |
| |
| SCHEMA PERSNL</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_set_show_current_schema">Set and Show the Current Schema</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_session">8.60. SHOW SESSION Command</h3> |
| <div class="paragraph"> |
| <p><code>SHOW SESSION</code> or <code>SESSION</code> displays attributes of the current TrafCI session. |
| You can also use the <code>ENV</code> command to perform the same function.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_58">8.60.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">[SHOW] SESSION</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_56">8.60.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| <li> |
| <p><code>SHOW SESSION</code> or <code>SESSION</code> displays these attributes:</p> |
| <table class="tableblock frame-all grid-all spread"> |
| <colgroup> |
| <col style="width: 20%;"> |
| <col style="width: 80%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Attribute</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>COLSEP</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current column separator, which is used to control how query results are displayed.<br> |
| <br> |
| For more information, <a href="#cmd_set_colsep">SET COLSEP Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>HISTOPT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current history options, which controls how the commands are added to the history buffer.<br> |
| <br> |
| For more information, see <a href="#cmd_set_histopt">SET HISTOPT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>IDLETIMEOUT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current idle timeout value, which determines when the session expire after a period of inactivity. |
| By default, the idle timeout is <code>30 minutes</code>.<br> |
| <br> |
| For more information, see <a href="#interactive_idle_timeout">Set and Show Session Idle Timeout Value</a> and |
| <a href="#cmd_set_idletimeout">SET IDLETIMEOUT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LIST_COUNT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current list count, which is the maximum number of rows that can be returned by SELECT statements. |
| By default, the list count is all rows.<br> |
| <br> |
| For more information, see <a href="#cmd_set_list_count">SET LIST_COUNT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LOG FILE</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current log file and the directory containing the log file. By default, logging during a session is turned off.<br> |
| <br> |
| For more information, see <a href="#interactive_log_output">Log Output</a>, and <a href="#cmd_log">LOG Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>LOG OPTIONS</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current logging options. By default, logging during a session is turned off, and this attribute does not appear in the output.<br> |
| <br> |
| For more information, see the <a href="#cmd_log">LOG Command</a> or <a href="#cmd_spool">SPOOL Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>MARKUP</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current markup option selected for the session. The default option is RAW.<br> |
| <br> |
| For more information, see <a href="#cmd_set_markup">SET MARKUP Command"</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>PROMPT</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current prompt for the session. For example, the default is <code>SQL></code>.<br> |
| <br> |
| For more information, see <a href="#interactive_customize_prompt">Customize the Standard Prompt</a> and <a href="#cmd_set_prompt">SET PROMPT Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SCHEMA</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current schema. The default is <code>USR</code>.<br> |
| <br> |
| For more information, see <a href="#interactive_set_show_current_schema">Set and Show the Current Schema</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SERVER</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Host name and port number that you entered when logging in to the database platform.<br> |
| <br> |
| For more information, see <a href="#trafci_login">Log In to Database Platform</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>SQLTERMINATOR</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current SQL statement terminator. The default is a semicolon (<code>;</code>).<br> |
| <br> |
| For more information, see <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a> and |
| <a href="#cmd_show_sqlterminator">SHOW SQLTERMINATOR Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>STATISTICS</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current setting (<code>on</code> or <code>off</code>) of statistics.<br> |
| <br> |
| For more information, see the <a href="#cmd_set_statistics">SET STATISTICS Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>TIME</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current setting (<code>on</code> or <code>off</code>) of the local time as part of the prompt. When this command is set to <code>on</code>, |
| military time is displayed. By default, the local time is <code>off</code>.<br> |
| <br> |
| For more information, see <a href="#interactive_customize_prompt">Customize the Standard Prompt</a> and <a href="#cmd_set_time">SET TIME Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>TIMING</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Current setting (<code>on</code> or <code>off</code>) of the elapsed time. By default, the elapsed time is <code>off</code>.<br> |
| <br> |
| For more information, see <a href="#interactive_display_elapsed_time">Display the Elapsed Time</a> and <a href="#cmd_set_timing">SET TIMING Command</a>.</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>USER</code></p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">User name that you entered when logging in to the database platform.<br> |
| <br> |
| For more information, see <a href="#trafci_login">Log In to Database Platform</a>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_49">8.60.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This SHOW SESSION command displays the attributes of the current session:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW SESSION |
| |
| COLSEP " " |
| HISTOPT DEFAULT [No expansion of script files] |
| IDLETIMEOUT 0 min(s) [Never Expires] |
| LIST_COUNT 0 [All Rows] |
| LOG FILE c:\session.txt |
| LOG OPTIONS APPEND,CMDTEXT ON |
| MARKUP RAW |
| PROMPT SQL> |
| SCHEMA SEABASE |
| SERVER sqws135.houston.host.com:23400 |
| SQLTERMINATOR ; |
| STATISTICS OFF |
| TIME OFF |
| TIMING OFF |
| USER user1</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This <code>SESSION</code> command shows the effect of setting various session attributes:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SESSION |
| |
| COLSEP " " |
| HISTOPT DEFAULT [No expansion of script files] |
| IDLETIMEOUT 30 min(s) |
| LIST_COUNT 0 [All Rows] |
| LOG OFF |
| MARKUP RAW |
| PROMPT SQL> |
| SCHEMA SEABASE |
| SERVER sqws135.houston.host.com:23400 |
| SQLTERMINATOR ; |
| STATISTICS OFF |
| TIME OFF |
| TIMING OFF |
| USER user1 |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_set_sqlprompt">8.61. SHOW SQLPROMPT Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW SQLPROMPT</code> command displays the value of the SQL prompt for the current TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_59">8.61.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW SQLPROMPT</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_57">8.61.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_10">8.61.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that the SQL prompt for the current session is <code>SQL></code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW SQLPROMPT |
| SQLPROMPT SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_sqlterminator">8.62. SHOW SQLTERMINATOR Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW SQLTERMINATOR</code> command displays the SQL statement terminator of the current TrafCI session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_60">8.62.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW SQLTERMINATOR</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_58">8.62.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_11">8.62.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that the SQL terminator for the current session is a period (<code>.</code>):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW SQLTERMINATOR |
| |
| SQLTERMINATOR .</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_set_show_terminator">Set and Show the SQL Terminator</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_statistics">8.63. SHOW STATISTICS Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW STATISTICS</code> command displays if statistics has been enabled or disabled for the current session.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_61">8.63.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW STATISTICS</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_59">8.63.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_12">8.63.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows <code>SHOW STATISTICS</code> disabled and then enabled:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW STATISTICS |
| |
| STATISTICS OFF |
| |
| SQL> SET STATISTICS ON |
| SQL> SHOW STATISTICS |
| |
| STATISTICS ON</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_time">8.64. SHOW TIME Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW TIME</code> command displays whether the setting for the local time in the interface prompt is <code>ON</code> or <code>OFF</code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_62">8.64.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW TIME</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_60">8.64.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_13">8.64.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows that the setting for the local time in the SQL prompt is <code>OFF</code>:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SHOW TIME |
| |
| TIME OFF</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_show_timing">8.65. SHOW TIMING Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SHOW TIMING</code> command displays whether the setting for the elapsed time is <code>ON</code> or <code>OFF</code>.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_63">8.65.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SHOW TIMING</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_61">8.65.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>If the <code>SET TIMING</code> command is set to <code>ON</code>, the elapsed time information is displayed.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_14">8.65.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command displays the elapsed time information because the <code>SET TIMING</code> command is enabled:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SET TIMING ON |
| SQL> SHOW TIME |
| |
| TIME OFF |
| |
| Elapsed :00:00:00.000</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_spool">8.66. SPOOL Command</h3> |
| <div class="paragraph"> |
| <p>The <code>SPOOL</code> command logs the entered commands and their output from TrafCI to a log file.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_64">8.66.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SPOOL { ON [ CLEAR, QUIET, CMDTEXT { ON | OFF } ] |
| | log-file [ CLEAR, QUIET, CMDTEXT { ON | OFF } ] |
| | OFF |
| }</code></pre> |
| </div> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>ON</code></p> |
| <div class="paragraph"> |
| <p>starts the logging process and records information in the <code>sqlspool.lst</code> file in the `bin directory.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>ON CLEAR</code></p> |
| <div class="paragraph"> |
| <p>instructs TrafCI to clear the contents of the <code>sqlspool.lst</code> file before logging new information to the file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>QUIET</code></p> |
| <div class="paragraph"> |
| <p>specifies that the command text is displayed on the screen, but the results of the command are written only to |
| the log file and not to the screen.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>CMDTEXT ON</code></p> |
| <div class="paragraph"> |
| <p>specifies that the command text and the log header are displayed in the log file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>CMDTEXT OFF</code></p> |
| <div class="paragraph"> |
| <p>specifies that the command text and the log header are not displayed in the log file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>log-file</em></code></p> |
| <div class="paragraph"> |
| <p>is the name of a log file into which TrafCI records the entered commands and their output. If you want the log file |
| to exist outside the local directory where you launch TrafCI (by default, the <code>bin</code> directory), then specify the |
| full directory path of the log file. The log file does not need to exist, but the specified directory must exist |
| before you execute the <code>SPOOL</code> command.</p> |
| </div> |
| </li> |
| <li> |
| <p><code><em>log-file</em> CLEAR</code></p> |
| <div class="paragraph"> |
| <p>instructs TrafCI to clear the contents of the specified <code><em>log-file</em></code> before logging new information to the file.</p> |
| </div> |
| </li> |
| <li> |
| <p><code>OFF</code></p> |
| <div class="paragraph"> |
| <p>stops the logging process.</p> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_62">8.66.2. Considerations</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </li> |
| <li> |
| <p>Use a unique name for each log file to avoid writing information from different TrafCI sessions into the same log file.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_examples_50">8.66.3. Examples</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command starts the logging process and records information to the <code>sqlspool.lst</code> file in the <code>bin</code> directory:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL ON</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to an existing log file, <code>persnl_updates.log</code>, |
| in the local directory (the same directory where you are running TrafCI):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL persnl_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to a log file, <code>sales_updates.log</code>, in the |
| specified directory on a Windows workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL c:\log_files\sales_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to a log file, <code>sales_updates.log</code>, |
| in the specified directory on a Linux or UNIX workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL ./log_files/sales_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and clears existing information from the log file before logging |
| new information to the file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> SPOOL persnl_ddl.log CLEAR</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command starts the logging process and records information to the <code>sqlspool.lst</code> file in the bin directory:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG ON</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to an existing log file, <code>persnl_updates.log</code>, |
| in the local directory (the same directory where you are running TrafCI):</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG persnl_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to a log file, <code>sales_updates.log</code>, |
| in the specified directory on a Windows workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\log_files\sales_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and appends new information to a log file, <code>sales_updates.log</code>, |
| in the specified directory on a Linux or UNIX workstation:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG ./log_files/sales_updates.log</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command starts the logging process and clears existing information from the log file before logging new |
| information to the file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG persnl_ddl.log CLEAR</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command start the logging process, clears existing information from the log file, and specifies that the |
| command text and log header is not displayed in the log file:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\temp\a.txt clear, CMDTEXT OFF |
| SQL> SELECT * FROM trafodion.toi.job |
| +>; |
| |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER |
| 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 10 row(s) selected. |
| |
| SQL> LOG OFF</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Output of <code>c:\temp\a.txt</code></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 10 row(s) selected</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command start the logging process, clears existing information from the log file, and specifies that no output |
| appears on the console window:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG c:\temp\b.txt CLEAR, CMDTEXT OFF, QUIET |
| SQL> SELECT * |
| +>FROM trafodion.toi.job; |
| SQL> LOG OFF</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Output of <code>c:\temp\b.txt</code></p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">==================== |
| JOBCODE JOBDESC |
| ------- ------------------ |
| 100 MANAGER |
| 450 PROGRAMMER |
| 900 SECRETARY |
| 300 SALESREP |
| 500 ACCOUNTANT |
| 400 SYSTEM ANALYST |
| 250 ASSEMBLER |
| 420 ENGINEER |
| 600 ADMINISTRATOR |
| 200 PRODUCTION SUPV |
| |
| --- 10 row(s) selected</code></pre> |
| </div> |
| </div> |
| </li> |
| <li> |
| <p>This command stops the logging process:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> LOG OFF</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>For more information, see <a href="#interactive_log_output">Log Output</a>.</p> |
| </div> |
| <div style="page-break-after: always;"></div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="cmd_version">8.67. VERSION Command</h3> |
| <div class="paragraph"> |
| <p>The <code>VERSION</code> command displays the build versions of the Trafodion database, Trafodion Connectivity Service, |
| Trafodion JDBC Type 4 Driver, and TrafCI.</p> |
| </div> |
| <div class="sect3"> |
| <h4 id="_syntax_65">8.67.1. Syntax</h4> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">VERSION</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_considerations_63">8.67.2. Considerations</h4> |
| <div class="paragraph"> |
| <p>You must enter the command on one line. The command does not require an SQL terminator.</p> |
| </div> |
| </div> |
| <div class="sect3"> |
| <h4 id="_example_15">8.67.3. Example</h4> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>This command shows versions of the Trafodion database, Trafodion Connectivity Service, Trafodion JDBC Type 4 Driver, and TrafCI:</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">SQL> VERSION |
| |
| Trafodion Platform : Release 0.8.0 |
| Trafodion Connectivity Services : Version 1.0.0 Release 0.8.0 |
| Trafodion JDBC Type 4 Driver : Traf_JDBC_Type4_Build_40646) |
| Trafodion Command Interface : TrafCI_Build_40646 |
| |
| SQL></code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div style="page-break-after: always;"></div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>If TrafCI is started with the -noconnect parameter, the <code>VERSION</code> command displays only TrafCI and the |
| Trafodion JDBC Type 4 Driver versions.</p> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="CodeRay highlight"><code data-lang="text">C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin> TRAFCI -noconnect |
| |
| Welcome to Trafodion Command Interface |
| Copyright(C) 2013-2105 Apache Software Foundation |
| |
| SQL> VERSION |
| |
| Trafodion Platform : Information not available. |
| Trafodion Connectivity Services : Information not available. |
| Trafodion JDBC Type 4 Driver : Traf_JDBC_Type4_Build_40646 |
| Trafodion Command Interface : TrafCI_Build_40646</code></pre> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer-text"> |
| Version 2.4.0<br> |
| Last updated 2020-04-17 22:23:23 PDT |
| </div> |
| </div> |
| <script> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount','UA-72491210-1']); |
| _gaq.push(['_trackPageview']); |
| (function() { |
| var ga = document.createElement('script'); |
| ga.type = 'text/javascript'; |
| ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(ga, s); |
| })(); |
| </script> |
| </body> |
| </html> |
