Skip to content

Commit 35a0440

Browse files
Tenerravicious
andauthored
Update Oracle client docs for Teleport v17.2.0+ (#49994)
* Update Oracle client docs for Teleport v17.2.0+ * remove docs for deprecated extension * Run images through ImageOptim * Add `@2x` suffix to high DPI images --------- Co-authored-by: Rafał Cieślak <rafal.cieslak@goteleport.com>
1 parent 7a12f63 commit 35a0440

15 files changed

+139
-10
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/pages/connect-your-client/gui-clients.mdx

Lines changed: 139 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -501,31 +501,160 @@ Click "Proceed", then click "Finish".
501501

502502
(!docs/pages/includes/database-access/gui-clients/spanner-reuse-port-note.mdx!)
503503

504-
## Oracle SQL Developer
504+
## Oracle graphical clients
505505

506506
The Oracle integration works only in the authenticated proxy mode. Start a local proxy for connections to your Oracle database by using the command below:
507+
507508
```
508-
tsh proxy db --tunnel --port 1521 --db-user=<user> --db-name=<db-name> oracle
509+
> tsh proxy db --tunnel --port 11555 --db-user=<user> --db-name=<db-name> oracle
510+
511+
Started authenticated tunnel for the Oracle database "oracle" in cluster "teleport.example.com" on 127.0.0.1:11555.
509512
```
510513

511514
<Notice type="tip">
512-
This command uses the local port 1521, but you can choose any port, or let
513-
`tsh` pick a local port at random if you omit the `--port` flag.
514-
You should specify a port to avoid the need to reconfigure your GUI client again
515-
later.
515+
The command above uses the local port 11555, but you can choose any available port. Leaving `--port` empty will cause `tsh` to pick a random one.
516+
</Notice>
517+
518+
The local proxy supports TCP and TCPS modes. Different clients prefer different modes.
519+
520+
TCP:
521+
- requires no username or password
522+
- generally easier to configure
523+
524+
TCPS:
525+
- requires no username or password
526+
- depends on automatically created wallet
527+
- uses JDBC URL for configuration
528+
529+
<Notice type="warning">
530+
Teleport versions earlier than 17.2.0 support only a limited range of clients and only offer TCPS mode. `tsh` will automatically detect this situation and warn the user. We recommend updating to the latest version of Teleport to access full client support and additional connection options.
516531
</Notice>
517532

533+
### Oracle SQL Developer (standalone)
534+
518535
In "Connections" click the "+" button for a new database connection:
519536

520-
![Oracle SQL Developer Add Database Connection](../../img/database-access/guides/oracle/oracle-sql-developer-add-database.png)
537+
![Oracle SQL Developer Add Database Connection](../../img/database-access/guides/oracle/sql-developer-standalone-add-database.png)
521538

522539
Next, set the name and username from the `--db-user` parameter. Set connection type to "Custom JDBC" and
523540
set the "Custom JDBC URL" from the `tsh proxy db` command.
524541

525-
![Oracle SQL Developer](../../img/database-access/guides/oracle/oracle-sql-developer-general.png)
542+
![Oracle SQL Developer](../../img/database-access/guides/oracle/sql-developer-standalone-conn-details-tcps.png)
526543

527544
Now you can click "Test" to check your configuration.
528545

529-
![Oracle SQL Developer Success](../../img/database-access/guides/oracle/oracle-sql-developer-success.png)
546+
![Oracle SQL Developer Success](../../img/database-access/guides/oracle/sql-developer-standalone-success.png)
547+
548+
### Oracle SQL Developer (VS Code extension)
549+
550+
Install the extension from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Oracle.sql-developer).
551+
552+
Both TCP and TCPS modes can be used.
553+
554+
<Tabs>
555+
<TabItem label="TCP">
556+
557+
Open the extension toolbar and click on "Create Connection" button.
558+
559+
![SQL Developer (VS Code) Start](../../img/database-access/guides/oracle/sql-developer-vscode-start@2x.png)
560+
561+
Enter the following connection details:
562+
563+
| Field | Value |
564+
|-----------------|------------------------|
565+
| Connection name | Choose unique name |
566+
| User name | `/` |
567+
| Password | `/` |
568+
| Save Password | Mark checkbox |
569+
| Connection type | Basic |
570+
| Host name | `localhost` |
571+
| Port number | `--port` flag value |
572+
| Type | Service Name |
573+
| Service name | `--db-name` flag value |
574+
575+
Test and create the connection.
576+
577+
![SQL Developer (VS Code) Connection Details (basic)](../../img/database-access/guides/oracle/sql-developer-vscode-conn-details-basic@2x.png)
578+
579+
The new connection should appear on the list.
580+
581+
<Figure width="400">
582+
![SQL Developer (VS Code) Connected (basic)](../../img/database-access/guides/oracle/sql-developer-vscode-connected-basic@2x.png)
583+
</Figure>
584+
585+
</TabItem>
586+
587+
<TabItem label="TCPS">
588+
589+
Open the extension toolbar and click on "Create Connection" button.
590+
591+
![SQL Developer (VS Code) Start](../../img/database-access/guides/oracle/sql-developer-vscode-start@2x.png)
592+
593+
Enter the following connection details:
594+
595+
| Field | Value |
596+
|------------------|---------------------------------|
597+
| Connection name | (choose per your preference) |
598+
| User name | `/` |
599+
| Password | `/` |
600+
| Save Password | Mark the checkbox |
601+
| Connection type | "Custom JDBC" |
602+
| Custom JDBC URL | Copy from `tsh proxy db` output |
603+
604+
Test and create the connection.
605+
606+
![SQL Developer (VS Code) Connection Details (JDBC)](../../img/database-access/guides/oracle/sql-developer-vscode-conn-details-jdbc@2x.png)
607+
608+
The new connection should appear on the list.
609+
610+
<Figure width="400">
611+
![SQL Developer (VS Code) Connected (JDBC)](../../img/database-access/guides/oracle/sql-developer-vscode-connected-jdbc@2x.png)
612+
</Figure>
613+
614+
615+
</TabItem>
616+
</Tabs>
617+
618+
### Toad
619+
620+
Add new login record in the logins dialog.
621+
622+
![Toad Add Login Record](../../img/database-access/guides/oracle/toad-add-login-record@2x.png)
623+
624+
Enter the connection details in "Direct" tab:
625+
626+
| Field | Value |
627+
|-----------------|------------------------------|
628+
| Host name | `127.0.0.1` |
629+
| Port number | `--port` flag value |
630+
| Service name | `--db-name` flag value |
631+
| User name | `EXTERNAL` |
632+
| Password | (leave empty) |
633+
| Connection name | (choose per your preference) |
634+
635+
Test the connection to verify the setup.
636+
637+
![Toad Add Login Tested](../../img/database-access/guides/oracle/toad-add-login-tested@2x.png)
638+
639+
The newly added login should appear on the login list.
640+
641+
![Toad Login List](../../img/database-access/guides/oracle/toad-login-list@2x.png)
642+
643+
<Notice type="tip">
644+
You can also configure Toad to use an external Oracle client. Both native and external clients are supported.
645+
</Notice>
646+
647+
### DBeaver
648+
649+
Click on the "New Database Connection" button.
650+
651+
![DBeaver new connection button](../../img/database-access/guides/oracle/dbeaver-new-connection@2x.png)
652+
653+
Select "Oracle" from the driver list. You may use the search toolbar to narrow down the list.
654+
![DBeaver connect to a database](../../img/database-access/guides/oracle/dbeaver-connect-to-a-database@2x.png)
655+
656+
Choose "Custom" connection type and paste the JDBC connection string printed by `tsh proxy db`.
657+
![DBeaver JDBC details](../../img/database-access/guides/oracle/dbeaver-jdbc-details@2x.png)
658+
659+
Test the connection to verify the setup. Finalize by clicking "Finish".
530660

531-
Congratulations! You have just connected to your Oracle instance.

0 commit comments

Comments
 (0)