Preface
This guide equips developers with essential tools, SDKs, APIs, and proven practices to unlock the full capabilities of Oracle Backend for Firebase. From initiating your first project and setting up authentication to integrating object storage and client SDKs, the documentation provides clear, step-by-step support throughout your development journey.
Preface Topics:
Audience
This documentation is intended for developers, DevOps engineers, and technical architects working with Oracle AI Database on the on-prem version. Whether you're building internal tools or customer-facing apps, this guide will help you accelerate development and ensure robust backend integration.
Parent topic: Preface
What is Covered in this Documentation?
Oracle Backend for Firebase offers a modular, enterprise-grade backend framework that can be deployed entirely within your on-premises infrastructure. Designed for organizations that require full control over data, security, and compliance, Oracle Backend for Firebase enables rapid backend provisioning while integrating seamlessly with your existing Oracle RDBMS, authentication systems, and storage solutions.
This documentation provides a comprehensive walkthrough for deploying and managing the Backend for Firebase in an on-prem environment - from database and storage setup to RESTful service enablement and client SDK integration. From building applications and creating collections to enabling the backend infrastructure and setting up provider logins, each guide is easy to follow and helps you to get started with building your application with minimal effort.
-
Project & Application Setup: Learn how to create the Backend for Firebase projects, configure applications, and set up the Console for streamlined development workflows.
-
Authentication & Security: Configure BASE, LDAP, or IDCS authentication, enable social login, and define fine-grained security rules for your collections. The authentication section covers authentication models (email/password. OAuth, enterprise identity providers) and explains session handling, token management (JWT, refresh token), and best practices for securing endpoints.
-
Database Configuration: Follow detailed steps to provision and configure Oracle AI Database, including tablespace creation, schema setup, and privilege management for the Backend for Firebase integration. The database services section describes the available database models (SQL-relational, NoSQL-document) and explains the data schema, indexing, querying, and transactions.
-
Object Storage Integration: Set up DBFS or OCI-based object storage, link existing file systems, and manage storage buckets for seamless backend file operation. The object storage section details storage capabilities for files (images, media) and large binary data, and role-based access control and policy enforcement.
-
User Management: Handle user onboarding, password resets, email verification and provider login setup with sign-up and sign-in processes.
-
Client SDKs: Integrate seamlessly with multi-platform SDKs including JavaScript (Modular and Namespaced), iOS (Swift), Android (Java), and Flutter (Dart), with detailed setup guides and usage instructions and examples.
-
Infrastructure & Deployment: Install the Backend for Firebase manually or through ORDS, configure load balancers, and manage encryption keys and wallets for secure deployment. Follow best practices for Oracle Backend for Firebase installation and object storage configuration.
Parent topic: Preface
Related Documents
SDKs and Integrations
This guide lists all available classes and methods in the client libraries (JavaScript, Flutter, iOS, Android) and shows you how to integrate services into different applications.
API Reference
The API reference guide documents the REST endpoints (ORDS) and provides request/response formats, error codes, and usage examples.
You can find more information in these documents of the Oracle AI Database documentation library:
Parent topic: Preface
Conventions
This guide uses these text conventions:
| Convention | Meaning |
|---|---|
|
boldface |
Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary. |
|
italic |
Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. |
|
|
Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. |
Parent topic: Preface