OraDBA Extras Extension Documentation

Current version: see ../VERSION | Release Notes Latest release: v0.2.0

Overview

The OraDBA Extras extension provides shell wrappers and configurations for user-specific tools that may not be available in the standard OS installation.

Tools Included

GNU tar

Enhanced tar command with additional features not available in BSD tar (macOS default).

OCI CLI

Oracle Cloud Infrastructure command-line interface wrapper with user-specific configurations.

jq

JSON processor for command-line JSON manipulation.

Adding New Tools

When adding new tools to this extension:

As a User (Adding to Installed Extension)

1. Download or copy your tool to the extension's bin/ directory
2. Make it executable: chmod +x bin/your_tool
3. Update checksums: ./bin/oradba_checksum.sh
4. Verify: ./bin/oradba_checksum.sh --verify

Example:

cd ${ORADBA_LOCAL_BASE}/odb_extras
wget https://example.com/tool -O bin/my_tool
chmod +x bin/my_tool
./bin/oradba_checksum.sh

As a Developer (During Development)

1. Add the tool wrapper to bin/
2. Add configuration examples to etc/ (if needed)
3. Update checksums: ./scripts/checksum.sh update
4. Test the tool integration
5. Update this documentation

See Checksum Management for complete details on maintaining file integrity and handling binary tools.

Configuration

Place configuration files in etc/ directory. Tool-specific configurations should use the pattern:

• etc/<toolname>.conf - Main configuration
• etc/<toolname>.conf.example - Example configuration

Usage

Once installed, all tools are available in your PATH through OraDBA's environment management.

# Example usage of GNU tar
gtar -czf archive.tar.gz directory/

# Example usage of jq
echo '{"name":"test"}' | jq .name

Documentation

• Checksum Management - Managing file integrity and checksums
• Release Notes - Version history and changes
• v0.2.0 Release Note - Optional env/alias hook support

Extension Hooks (env/aliases)

The extension includes optional hook files in etc/:

• etc/env.sh
• etc/aliases.sh

By default these hooks are disabled in .extension:

• load_env: false
• load_aliases: false

To enable them, set ORADBA_EXTENSIONS_SOURCE_ETC=true and change the corresponding .extension flags to true.