Oracle SQLcl

Copyright © 2014 Oracle and/or its aﬃliates. All rights reserved. |
SQLcl: Making SQL*Plus the tool
you need for development
Your New Command Line Interface for Oracle Database

Barry McGillin
Director SoJware Development
Barry.mcgillin@oracle.com || @bamcgill
Database Tools, Oracle Corp

Safe Harbor Statement
The preceding is intended to outline our general product direcRon. It is intended for
informaRon purposes only, and may not be incorporated into any contract. It is not a
commitment to deliver any material, code, or funcRonality, and should not be relied upon
in making purchasing decisions. The development, release, and Rming of any features or
funcRonality described for Oracle’s products remains at the sole discreRon of Oracle.

§ Developer Tools - SQLcl
§  Walk and Talk It
§  Show It
§  Questions As We Go, Mostly Improve
applicaRon
developers
experience
Agenda

§  FREE Oracle Database IDE/GUI
§  Windows, OS X, *NIX
§  More than 4,100,000 users worldwide
§  My Oracle Support available via your DB license

SQL Developer Script Engine
Existing SQL*Plus Scripting Support in the GUI
§  Supported most SQL*Plus commands
§  Execute via F5 (as script)
§  What if…?

…We Could Take the Helpful GUI Elements
§  Object Name/Command Completion
§  SQL Execution History & Recall
§  Query Result Formatting
§  User friendly text editing
And wrap them in a cool Cool CLI??

A new way to work with Oracle Database…
…brought to you from the makers of SQL Developer

§  Java 7, JRE
§  ~13 MB download
§  Unzip & Go
§  Supports OCI/Thick
§  Early Adopter
§  Distributed with
SQL Developer v4.1
§  Binary is named ‘sql’
SQLcl

Why?
§  Not everyone likes a GUI for every task
§  SQL*Plus is great but lacks many modern features
§  Can we improve our users’ everyday experience
with our technology?
Improve
applicaRon
developers
experience Of Course!!!

Getting Started
§  Download
§  unzip
§  run ‘sql’
§  How to ‘install’

Run Anywhere
Windows, Unix, Mac, Cloud, VM, Cygwin, RPM, yum, pkg

(~) $sql user/password


$TWO_TASK
$ORACLE_HOME
$TNS_ADMIN

$TWO_TASK
TWO_TASK=<TNS ALIAS>

TWO_TASK=<CONNECTION STRING>

TWO_TASK=<SERVICE NAME>

(~) $sql user

@localhost:1521/orcl

Thin JDBC

(~) $sql user

@tns_alias

$TNS_ADMIN

(~) $sql user

@(DESCRIPTION=(ADDRESS
= (PROTOCOL = TCP)
(HOST = 0.0.0.0)(PORT = 1521))
(CONNECT_DATA =(SERVER =
DEDICATED)
(SERVICE_NAME = orcl)))


SQLcl: Release <VERSION> on <DATE>

Copyright (c) 1982, 2015, Oracle. All rights reserved.

Connected to:
Oracle Database 12c Enterprise Edition Release 12.1.0.2.0 - 64bit Production
With the Partitioning, OLAP, Advanced Analytics and Real Application Testing options

SQL>

Connection Properties

SQL> show jdbc

…...

SQL> show connection

…...

You showed TNS. Where’d you ﬁnd it?

SQL> show tns
SQL> show tns
TNS Lookup locations
--------------------
1. USER Home dir
/Users/bamcgill
Location used:
-------------

/Users/bamcgill

Lets create a table

SQL> create table emp as
2* select * from hr.employees

Table EMP created.

Lets create another

SQL> CTAS emp emp2
CTAS
SQL> CTAS emp emp2
CREATE TABLE ”DEMO"."EMP2"
( "EMPLOYEE_ID", "FIRST_NAME",
"LAST_NAME”, "EMAIL”,
"PHONE_NUMBER”, "HIRE_DATE",
"JOB_ID”, "SALARY”, "COMMISSION_PCT",
"MANAGER_ID”, "DEPARTMENT_ID"
) SEGMENT CREATION IMMEDIATE
PCTFREE 10 PCTUSED 40 INITRANS 1 MAXTRANS 255

SQL> CTAS emp emp2
CREATE TABLE ”DEMO"."EMP2"
( "EMPLOYEE_ID", "FIRST_NAME",
"LAST_NAME”, "EMAIL”,
"PHONE_NUMBER”, "HIRE_DATE",
"JOB_ID”, "SALARY”, "COMMISSION_PCT",
"MANAGER_ID”, "DEPARTMENT_ID"
) SEGMENT CREATION IMMEDIATE
PCTFREE 10 PCTUSED 40 INITRANS 1 MAXTRANS 255
NOCOMPRESS LOGGING
STORAGE(INITIAL 65536 NEXT 1048576 MINEXTENTS 1 MAXEXTENTS 2147483645
PCTINCREASE 0 FREELISTS 1 FREELIST GROUPS 1
BUFFER_POOL DEFAULT FLASH_CACHE DEFAULT CELL_FLASH_CACHE DEFAULT)
TABLESPACE "USERS"
as
select * from EMP

Lets do some querying


SQL> Select * from EMP

⇥
Cursor
Keys

EMP EMP2

Completion
Insight



Completion
Insight
⇥

COMMISSION_PCT DEPARTMENT_ID EMAIL
EMPLOYEE_ID FIRST_NAME HIRE_DATE
JOB_ID LAST_NAME MANAGER_ID
PHONE_NUMBER SALARY

SQL> Select * from EMP;

COMMISSION_PCT DEPARTMENT_ID EMAIL
EMPLOYEE_ID FIRST_NAME HIRE_DATE
JOB_ID LAST_NAME MANAGER_ID
PHONE_NUMBER SALARY

SQL> Select FIRST_ from EMP;

⇥


SQL> Select FIRST_NAME from EMP;


SQL> Select FIRST_NAME, L from EMP;

⇥


SQL> Select FIRST_NAME, LAST_NAME from EMP;


SQL> Select FIRST_NAME, LAST_NAME from EMP
2 * fetch ﬁrst 5 rows only;


SQL> Select FIRST_NAME, LAST_NAME from EMP
2 * fetch ﬁrst 5 rows only;

FIRST_NAME LAST_NAME
-------------------- -------------------------
Steven King
Neena Kochhar
Lex De Haan

SQL >COLUMN FIRST_NAME FORMAT A10
SQL >COLUMN LAST_NAME FORMAT A10
SQL >COLUMN SALARY FORMAT $9,999,999
SQL>

SQL*Plus fully supported


SQL> Select FIRST_NAME, LAST_NAME, SALARY
2 from EMP
3* fetch ﬁrst 5 rows only;

Lets try that query again.


2 from EMP

FIRST_NAME LAST_NAME SALARY
---------- ---------- -----------
Steven King $24,000

SQL> BREAK on job_id on row
SQL> COMPUTE avg OF SALARY ON JOB_ID row

SQL> select department_id, job_id, salary
2 FROM EMP
3 WHERE SALARY > 12000
4 ORDER BY DEPARTMENT_ID, JOB_ID,
5*SALARY, LAST_NAME ;
Break & Compute too


2 FROM EMP
3 WHERE SALARY > 12000
5*SALARY, LAST_NAME ;

DEPARTMENT_ID JOB_ID SALARY
------------- ---------- ----------
20 MK_MAN 13000

Formats for Everyone
In the audience
html
xml
json
csv
insert
loader
ansiconsole


SQL> set sqlformat csv
2 from EMP

CSV


SQL> set sqlformat csv
2 from EMP

"FIRST_NAME","LAST_NAME","SALARY"


SQL> set sqlformat json
2 from EMP

json


SQL> set sqlformat json
2 from EMP

{"items":
[


SQL> set sqlformat ansiconsole
SQL> /

ansiconsole


SQL> set sqlformat ansiconsole
SQL> /

FIRST_NAME LAST_NAME SALARY
Steven King $24,000
Neena Kochhar $17,000

Formats are nice
What can I do with that?

Export of Course!
SQL> set term off

SQL> set feedback off

SQL> select * from emp;
SQL> select * from emp;

"EMPLOYEE_ID","FIRST_NAME","LAST_NAME","EMAIL","PHONE_NUMBER
100,"Steven","King","SKING","515.123.4567",17-JUN-87,"AD_PRES",24000,,,

Whys all that showing?
Interactive Mode!

Lets stick it in a ﬁle and run it then
SQL> !cat export.sql
set term off
set feedback off

SQL> @export

SQL>

SQL> !wc –l export.csv
109 export.csv

SQL>

So what if I
want to load it in again

Just do it!
SQL> drop table emp2;
SQL> create table emp2 as select * from emp;
SQL> load emp2 export.csv

SQL> drop table emp2;

SQL> create table emp2 as select * from emp;
Table EMP2 created.

SQL> load emp2 export.csv
--Number of rows processed: 107
--Number of rows in error: 0
0 - SUCCESS: Load processed without errors
SQL>

Lets save the DDL now then

SQL> ddl emp2

CREATE TABLE "BARRY"."EMP2"
(
"EMPLOYEE_ID" NUMBER(6,0),

"FIRST_NAME" VARCHAR2(20),

But I don’t want storage and extents in it

SQL> show ddl

STORAGE : ON
INHERIT : ON
SQLTERMINATOR : ON
OID : ON
SPECIFICATION : ON
TABLESPACE : ON
SIZE_BYTE_KEYWORD : ON
PRETTY : ON
REF_CONSTRAINTS : ON
FORCE : ON
PARTITIONING : ON
CONSTRAINTS : ON
INSERT : ON
BODY : ON

SQL> set ddl storage off
DDL Option STORAGE off

SQL> set ddl SEGMENT_ATTRIBUTES off
DDL Option SEGMENT_ATTRIBUTES off

SQL>

SQL> show ddl

STORAGE : OFF
INHERIT : ON
SQLTERMINATOR : ON
OID : ON
SPECIFICATION : ON
TABLESPACE : ON
SIZE_BYTE_KEYWORD : ON
PRETTY : ON
REF_CONSTRAINTS : ON
FORCE : ON
PARTITIONING : ON
CONSTRAINTS : ON
INSERT : ON
BODY : ON

SQL> ddl emp2

And I want to save it

SQL> ddl emp2 save emp2.sql

SQL> !cat emp2.sql

What about reports?
Or snippets?

Aliases
Code
SQL
PLSQL
SCRIPT
All Runnable with binds as parameters


SQL> alias sql=select 1 from dual;
SQL>
SQL> alias plsql=declare
2 variable number;
3 begin
4 select 1 into :variable from dual;
5 dbms_output.put_line(:variable);
6 end;
SQL>
alias

SQL> alias qscript=q'[
2 set echo off
3 set feedback off
4 select username from all_users
5 where username = :NAME;
6 set feedback on
7 set echo on
8* ]’;
alias

Lets do some aliasing then

SQL> alias

plsql
script
sql

alias
This doesn’t tell us much so
We can add a description

SQL> alias desc plsql example of plsql alias
SQL> alias list

plsql - example of plsql alias
script
sql

alias

SQL> sql
1
----------
1
1 row selected
SQL>
alias

SQL> set serveroutput on
SQL> plsql 1

PL/SQL procedure successfully completed.

1

SQL>
alias

SQL> qscript DEMO
SQL> set echo off

USERNAME
------------------
DEMO

SQL>
alias

Now what was that query again?
SQL>
é
2 from EMP
2 FROM EMP
3 W
5*SALARY, LAST_NAME
é

SQL> his

History: show no failures
1 select department_id, job_id, salary FROM EMP
2 Select FIRST_NAME, LAST_NAME, SALARY from EM
SQL>

SQL> his full
1 select department_id, job_id, salary
> FROM EMP
> WHERE SALARY > 12000
> ORDER BY DEPARTMENT_ID, JOB_ID,
> SALARY, LAST_NAME

2 Select FIRST_NAME, LAST_NAME, SALARY
> from EMP
> fetch ﬁrst 5 rows only

SQL>

Full list of statements in history

SQL> his time

1 (01.927) select department_id, job_id, salary FROM
2 (00.015) Select FIRST_NAME, LAST_NAME, SALARY
SQL>
SQL Execution time of last run

SQL> select * from non_table;

Error starting at line : 1 in command -
select * from non_table
Error at Command Line : 1 Column : 15
Error report -
SQL Error: ORA-00942: table or view does not exist
00942. 00000 - "table or view does not exist"
Fake
Table
query
What about failures!!

SQL> his

History: show no failures
1 select department_id, job_id, salary FROM EMP
SQL>
It’s the same! Is it stored?

SQL> his fails

History will show failures.
SQL> his

History: show failures
1 select department_id, job_id, salary FROM EMP W
3 select * from non_table
SQL>
Yes, it is and you can ﬁlter it!

So what’s left then?

SQL> help

SQL> help

For help on a topic type help <topic>
List of Help topics available:
/ @ @@ ACCEPT ALIAS* APEX* APPEND
ARCHIVE_LOG BREAK BRIDGE* BTITLE CD* CHANGE
CLEAR COLUMN COMPUTE CONNECT COPY CTAS* DDL*
DEFINE DEL DESCRIBE DISCONNECT EDIT EXECUTE EXIT
FORMAT* GET HISTORY* HOST INFORMATION* INPUT LIST
LOAD* NET* NOHISTORY* OERR* PASSWORD PAUSE
PRINT PROMPT QUIT REMARK REPEAT*
RUN SAVE SCRIPT* SET SHOW
SHUTDOWN SODA* SPOOL SSHTUNNEL* START STARTUP
STORE TIMING TNSPING* TTITLE UNDEFINE VARIABLE
WHENEVER XQUERY

But where do you get it.
And I don’t have an ORACLE_HOME…...

BARRY@orcl🍻🍺 >show login
Glogin possible locations
/Users/bamcgill/code/workspace/common/sqlcl/built/
/Users/bamcgill/oracle/sqlplus/admin/

glogin.sql :
/Users/bamcgill/oracle/sqlplus/admin/glogin.sql

Login possible locations
/Users/bamcgill/code/workspace/common/sqlcl/built/
./

login.sql
./login.sql
BARRY@orcl🍻🍺 >

Script

SQL>@hxps://gist.githubusercontent.com/bamcgill/d28420608da65d562e3a/
raw/e34529bfed476748576cc2603310b4be02ea9a80/login.sql
BARRY@orcl🍀>

BARRY@orcl🍀> get hxps://gist.githubusercontent.com/bamcgill/d28420608da65d562

BARRY@orcl🍀>script
2 var dbUser = uRl.executeReturnOneCol('select user from dual');
3
4 if ( dbUser == 'KLRICE' ) {
5 sqlcl.setStmt('set sqlprompt "@|red _USER|@@@|green _CONNECT_IDENTIFIER|@@|blue 🍺 >|@"');
6 } else if ( dbUser == 'JEFF') {
7 sqlcl.setStmt('set sqlprompt "@|RED _USER|@@@|green _CONNECT_IDENTIFIER|@@|blue 💩 >|@"');
8 } else if ( dbUser == 'DOM') {
9 sqlcl.setStmt('set sqlprompt "@|RED _USER|@@@|green _CONNECT_IDENTIFIER|@@|blue 🍷 >|@"');
10 } else if ( dbUser == 'PENNY') {
11 sqlcl.setStmt('set sqlprompt "@|RED _USER|@@@|green _CONNECT_IDENTIFIER|@@|blue 🚲 >|@"');
12 } else if ( dbUser == 'BARRY') {
13 sqlcl.setStmt('set sqlprompt "@|RED _USER|@@@|green _CONNECT_IDENTIFIER|@@|blue ☘ >|@"');
14 } else {
15 sqlcl.setStmt('set sqlprompt "@|blue _USER|@@@|green _CONNECT_IDENTIFIER|@@|blue 🍼 >|@"');
16 }
17
18 sqlcl.run();
19

You said we could change directories…
SQL> show sqlpath

SQLPATH : /Users/bamcgill/demo:/Users/bamcgill/qa/:.

Yes, but need to know where you are ﬁrst!

Now you can change directories
SQL> cd ../code
SQL>
SQL> show sqlpath

SQLPATH : /Users/bamcgill/code:/Users/bamcgill/qa/:.

SODA

SODA
SODA allows schemaless applicaRon development using the JSON data model.
SODA create <collecRon_name>
Create a new collecRon
SODA list
List all the collecRons
SODA get <collecRon_name> [-all | -f | -k | -klist] [{<key> | <k1> <k2> ... > | <qbe>}]
List documents the collecRon
OpRonal arguments:
-k list docs matching the specific <key>
-klist list docs matching the list of keys
-f list docs matching the <qbe>
SODA insert <collecRon_name> <json_str | filename>
Insert a new document within a collecRon
SODA drop <collecRon_name>
Delete exisRng collecRon
SODA count <collecRon_name> [<qbe>]
Count # of docs inside collecRon.
OpRonal <qbe> returns # of matching docs
SODA replace <collecRon_name> <oldkey> <new_{str|doc}>
Replace one doc for another
SODA remove <collecRon_name> [-k | -klist |-f] {<key> | <k1> <k2> ... | <qbe>}
Remove doc(s) from collecRon
OpRonal arguments:
-k remove doc in collecRon matching the specific <key>
-klist remove doc in collecRon matching the list <key1> <key2> ... >
-f remove doc in collecRon matching <qbe>

BARRY@orcl >soda create OUGIRL
Successfully created collection: OUGIRL

BARRY@orcl >soda insert
OUGIRL{"content":“sqlclstuff"}
Json String inserted successfully.

BARRY@orcl >soda insert OUGIRL
{"location":“dublin"}

BARRY@orcl >soda insert OUGIRL
{"best_of_week":“SQLcl is SQL*Plus "}

SYS@DB11GR24🍻🍺 >apex
WORKSPACE APPLICATION_ID APPLICATION_NAME BUILD_STATUS
COM.ORACLE.CUST.REPOSITORY 8805 Theme: Sunrise Run and Develop
COM.ORACLE.CUST.REPOSITORY 8806 Theme: Centered Blue Run and Develop
COM.ORACLE.CUST.REPOSITORY 8807 Theme: Modern Blue Run and Develop
COM.ORACLE.CUST.REPOSITORY 8808 Theme: Orange Run and Develop
COM.ORACLE.CUST.REPOSITORY 8809 Theme: Simple Gray Run and Develop
....
apex

OERR
INFORMATION
Whats left now?
SSHTunnels
NET
TNSPING

A Better describe…...

That’s great.
Whats Next?

YouTube Overview (10 Minutes)
Barry’s Blog
Kris’ Blog
How to install & connect
Download OTN
Resources

Oracle SQLcl

Recommended

More Related Content

What's hot (20)

Viewers also liked (9)

Similar to Oracle SQLcl (20)

Recently uploaded (20)

Oracle SQLcl