OraDBA User Documentation¶
Complete user guides and reference materials for the Oracle Database Administration Toolset.
Version: 0.21.x | Audience: Database administrators, operators, and users managing Oracle environments
For Developers
See Developer Documentation for contribution guides, API reference, and technical architecture.
Documentation Formats¶
The complete OraDBA user documentation is available in multiple formats:
- Online Documentation - Browse with search and navigation
- PDF User Guide - Download for offline use
Documentation Structure¶
Getting Started¶
| Document | Description |
|---|---|
| Introduction | What is OraDBA and why use it |
| Installation | Complete installation guide |
| Quick Start | Get up and running in 5 minutes |
Configuration & Environment¶
| Document | Description |
|---|---|
| Configuration System | 6-level configuration hierarchy |
| Advanced Configuration | Multi-version, Grid, ROOH, products |
| Environment Management | Registry API and Plugin System |
Commands & Features¶
| Document | Description |
|---|---|
| Aliases Reference | Aliases, PDB aliases, rlwrap |
| Functions Reference | Available shell functions |
| SQL Scripts | SQL script library reference |
| RMAN Scripts | RMAN backup script templates |
Extensions & Customization¶
| Document | Description |
|---|---|
| Extension System | Creating, managing, and available extensions |
Operations & Support¶
| Document | Description |
|---|---|
| Service and Log Operations | Service management and log rotation |
| SQL*Net Configuration | SQLNet and network configuration |
| Troubleshooting | Common issues and solutions |
Quick Start¶
# Install
curl -L -o oradba_install.sh \
https://github.com/oehrlis/oradba/releases/latest/download/oradba_install.sh
chmod +x oradba_install.sh && ./oradba_install.sh
# Set environment and start working
source /opt/oradba/bin/oraenv.sh FREE
sq # sqlplus / as sysdba
alih # Show all aliases
See Quick Start Guide for detailed first steps.
Finding What You Need¶
| If you want to... | Start here |
|---|---|
| Learn what OraDBA is | Introduction |
| Install OraDBA | Installation |
| Get started quickly | Quick Start |
| Customize your setup | Configuration System |
| See available commands | Aliases Reference or run alih |
| Extend functionality | Extension System |
| Fix issues | Troubleshooting |
| Quick command lookup | Quick Start |
| See practical examples | Quick Start |
Support¶
- Issues & Bugs: https://github.com/oehrlis/oradba/issues
- Discussions & Questions: https://github.com/oehrlis/oradba/discussions
- Source Code: https://github.com/oehrlis/oradba
License¶
Copyright © 2026 Stefan Oehrli
Licensed under the Apache License, Version 2.0. See LICENSE for details.
OraDBA v1.0.0 - Modern Oracle Database Administration Toolset