Everything You Need to Know

OneDB Overview

Versioning, Updates and Upgrades

Estimated reading: 4 minutes 23 views

This section explains how OneDB versions are structured and how updates and upgrades are managed across OneDB releases.

OneDB uses versioning to help administrators, partners, and customers understand the type of changes included in each release. Version numbers indicate whether a release contains major changes, new features, improvements, bug fixes, or maintenance updates.

Version Format

OneDB versions follow a structured version format:

Major.Minor.Patch

Example:

2.3.0
Version Segment Example Description
Major 2 Indicates a major release that may include significant architectural changes, major features, or compatibility changes.
Minor 3 Indicates a feature release that may include new capabilities, enhancements, and improvements.
Patch 0 Indicates a maintenance release that usually includes bug fixes, stability improvements, and minor refinements.

Major Releases

A major release may introduce significant changes to OneDB, such as new architecture, major platform capabilities, new security modules, or changes that may require additional planning before deployment.

Example:

2.0.0

Major releases may include:

Change Type Description
New Architecture Significant changes to the internal system design or deployment model.
Major Features New product capabilities or major functional additions.
Compatibility Changes Changes that may affect existing configurations or integrations.
Upgrade Planning May require additional validation before being deployed in production.

Minor Releases

A minor release usually introduces new features, enhancements, or improvements while maintaining compatibility within the same major version.

Example:

2.3.0

Minor releases may include:

Change Type Description
New Features Additional product capabilities or modules.
Enhancements Improvements to existing features or workflows.
UI Improvements Updates to the administration interface or usability.
Performance Improvements Optimizations that improve stability, throughput, or responsiveness.

Patch Releases

A patch release usually contains bug fixes, security fixes, stability improvements, and small refinements.

Example:

2.2.1

Patch releases are typically used to address specific issues without introducing major functional changes.

Patch releases may include:

Change Type Description
Bug Fixes Fixes for known issues or unexpected behavior.
Security Fixes Updates to address security-related issues.
Stability Improvements Improvements that make the product more reliable.
Minor Adjustments Small changes that do not significantly alter product behavior.

Updates

An update generally refers to applying improvements or fixes within the same product version line.

Updates may include:

  • bug fixes
  • security patches
  • minor UI improvements
  • documentation updates
  • stability enhancements

Updates are usually lower risk than major upgrades, but should still be tested before being applied to production environments.

Upgrades

An upgrade refers to moving OneDB from one version to another version, especially when moving to a newer minor or major release.

Examples:

2.1.0 → 2.2.0
2.2.1 → 2.3.0
1.4.0 → 2.0.0

Upgrades may introduce new features, database changes, configuration changes, or behavior improvements.

Before performing an upgrade, administrators should review the release notes and validate the upgrade in a non-production environment when possible.

Recommended Upgrade Practice

Before upgrading OneDB, review the following:

Item Recommendation
Release Notes Review the release notes to understand new features, fixes, and known changes.
Backup Backup the current system configuration and related data before upgrading.
Compatibility Confirm compatibility with existing database connections, listeners, templates, and integrations.
Testing Test the upgrade in a staging or non-production environment first.
Maintenance Window Schedule the upgrade during an approved maintenance window.
Rollback Plan Prepare a rollback plan in case the upgrade cannot be completed successfully.

Release Notes

Each OneDB release may include release notes that describe the changes included in that version.

Release notes may contain:

Section Description
Release Date The date when the version was released.
Release Type Indicates whether the release is major, minor, or patch.
New Features New capabilities introduced in the release.
Enhancements Improvements to existing features.
Bug Fixes Issues resolved in the release.
Security Updates Security-related fixes or improvements.
Known Notes Important considerations before upgrading.

Upgrade Guide

For step-by-step upgrade instructions, refer to the Upgrade Guide under the Setup Guide section.

Documentation → Setup Guide → Upgrade Guide

The Upgrade Guide explains how to perform the upgrade from the OneDB console and verify that the Web UI is accessible after the upgrade.

Summary

OneDB versioning helps administrators understand the purpose and impact of each release.

Release Type Example Typical Purpose
Major Release 2.0.0 Major features, architecture changes, or compatibility changes.
Minor Release 2.3.0 New features, enhancements, and improvements.
Patch Release 2.2.1 Bug fixes, security fixes, and stability improvements.

For production environments, always review release notes, perform backups, and validate upgrades before applying changes to live systems.

Share this Doc

Versioning, Updates and Upgrades

Or copy link

Table of Contents