Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • What is Covered in this Documentation?
  • Related Documents
  • Conventions
• Part I Introduction
  • Introduction to Oracle Backend with Firebase APIs
    • What is Oracle Backend with Firebase APIs?
    • Integration with Oracle AI Database
    • Advantages of Using Oracle Backend with Firebase APIs
  • Fundamentals
    • Key Terms and Definitions
      • Generic Terms
      • Oracle-Specific Terms
    • Architecture Overview
    • Backend Overview
    • Supported Platforms
    • SDK Overview
    • Console Overview
    • CLI Overview
• Part II Setting Up Oracle Backend with Firebase APIs
  • Installing and Configuring Oracle Backend with Firebase APIs
    • What You Will Do
    • Prerequisites
    • Prepare the Database
      • Check the Database Version and Compatibility Setting
      • Enable Extended String Support
      • Configure the TDE Wallet and Master Key
    • Enable Oracle Backend with Firebase APIs in ORDS
      • Verify the ORDS Version
      • Run the Oracle Backend with Firebase APIs Installer
    • Prepare and Enable the Project Schema
      • Create the Schema
      • Grant the Required Database Privileges
      • Enable the Schema for Oracle Backend with Firebase APIs
    • Open the Console
    • Create Your First Project
    • Configure the CLI
      • Install the CLI from GitHub
      • Create an OAuth Client for the CLI
      • Create the CLI Configuration File
      • Sign In to the CLI
      • Confirm the CLI Can Reach Your Schema
    • Verify the Installation
    • Troubleshooting
  • Adding Oracle Backend with Firebase APIs to Your Apps
    • Before You Begin
    • Introduction
    • Choose Your Platform
    • Add Oracle Backend with Firebase APIs to a Web App
      • Prerequisites
      • Register Your Web App
      • Install the JavaScript SDK
      • Initialize the JavaScript SDK
      • Next Steps
    • Add Oracle Backend with Firebase APIs to an iOS App
      • Prerequisites
      • Register Your iOS App
      • Add the App Configuration
      • Add the iOS SDK
      • Configure the URL Scheme for Social Login
      • Initialize the iOS SDK
      • Other Installation Options
      • Next Steps
    • Add Oracle Backend with Firebase APIs to an Android App
      • Prerequisites
      • Java Android SDK Installation
      • Add the App Configurations
      • Add the Android SDK
      • Configure Android for Network Access and Social Login
      • Initialize the Android SDK
      • Other Installation Options
      • Next Steps
    • Add Oracle Backend with Firebase APIs to a Flutter App
      • Prerequisites
      • Register Your Flutter App
      • Flutter SDK Installation
      • Flutter SDK Initialization
      • Configure Android for Social Login Redirects
      • Other Installation Options
      • Next Steps
    • Troubleshooting
    • Next Steps
• Part III Setting Up and Managing Projects
  • Setting Up Oracle Backend with Firebase APIs Projects
    • Introduction to Projects
    • Why Projects Matter
      • Working with a Project (Console or CLI)
    • How Projects Relate to Applications and Services
    • What a Project Contains
    • Ownership, Access, and Boundaries
    • Database Roles and Project Roles
    • Administrative Preparation Before Project Creation
    • Application Registration Within a Project
    • App Configuration and Project Configuration
    • Managing a Project in Practice
      • Creating a Project
      • Managing Projects Using the Console and CLI
      • Assigning Project Roles to Other Users
      • Syncing Project Data
      • Revoking Project Access
      • Deleting a Project
    • Project Limitations and Operational Considerations
  • Managing Projects
    • Working with Projects
      • Viewing Your Project Information
    • Managing Project Members
      • Prerequisites
      • Updating Member Roles
• Part IV Authentication
  • Oracle Backend with Firebase APIs Authentication
    • Overview
    • Key Capabilities
    • App Users
    • Using Auth in your App
    • What is Authentication
  • Authenticating Application Users
    • App Users
    • Basic Properties
    • Sign-In Methods
    • Authentication Flow
    • Current User and Auth Listeners
    • Application User Self-service
    • Email Verification and Password Reset
      • SMTP Configuration
      • Email Verification
      • Password Reset
    • Auth Tokens
      • Auth Token Example
      • Auth Token Fields
    • Managing Application Users
    • JSON Web Key
  • Authentication Types
    • Basic Authentication
    • LDAP Authentication
    • IDCS Authentication
    • Which Path is Right for Me?
  • Setting Up Authentication
    • Prerequisites
    • Enabling Authentication for a Project
    • Basic Authentication Setup
    • LDAP Authentication Setup
    • IDCS Authentication Setup
    • Setting Up Third-Party Identity Providers
      • Set up Social Sign-in (GitHub, Google, and more)
      • Configuring OIDC and SAML Identity Providers
    • Configuring SMTP for Email Verification and Password Reset
    • Defining Password Policies
    • Changing Authentication Providers
      • Switching Authentication Providers
    • Setting Up and Managing Authentication Using CLI
    • Authorized Domains
  • Getting Started with Authentication SDK
    • Prerequisites
    • Getting Started
    • Pre-built UI
      • Using Pre-built UI
    • User Management Operations
    • Email Verification and Reset Password
    • Third-Party Identity Providers
      • Web Sign-In Flow
      • Android Sign-In Flows
      • iOS Sign-In Flows
    • Link Social Accounts
      • Unlink Social Accounts
    • Persistence Settings
    • Rate Limiting for Public Authentication Flows
  • Errors and Troubleshooting
    • Authentication Error Format
    • Common Authentication Errors
• Part V Database
  • Introduction
    • Overview
    • Key Terms
    • Data Models
    • What You Will Learn in This Section
    • How to Use This Section
  • Data Model
    • Document-Collection Model
    • Relational-to-Collection Mapping
    • Standalone Duality Views (Advanced)
    • Hierarchical Structure and Subcollections
    • Supported Data Types
  • Getting Started and Console Check
    • Overview
    • Create a Project and Register an App
    • Import and Initialize the SDK
    • Write a Document
    • Read it Back
    • Secure the Collection
    • Check the Console
  • Managing Collections
    • Prerequisites for Collection Management
    • Collections and Documents
    • Creating a Collection
    • Dropping a Collection
    • Getting a Collection List
  • Document Operations
    • Prerequisites
    • Write Operations
      • Supported Document Operations
        • Set a Document
          • Example: Set a Document with Merge Options
        • Add a Document
        • Update a Document
        • Delete a Document
      • Field-Level Semantics and Data Types
      • Security Rule Enforcement
    • Read Operations
      • Supported Read Operations
      • Query Capabilities and Semantics
        • Filtering with Conditions
        • Ordering and Pagination
        • Collection Group and Join Queries
        • Aggregation Functions
  • Access Data Offline in JavaScript Applications
    • How Offline Data Access Works
    • Before You Begin
    • Configure Offline Persistence
      • Use IndexedDB Persistence
      • Use Memory Persistence
    • Configure Cache Size and Multi-Tab Synchronization
    • Read and Query Cached Data
    • Listen to Offline Data
    • Write Data and Monitor Synchronization
      • Requirements for Offline Updates and Merges
      • Add Documents While Offline
    • Disable and Enable Network Access
    • Use Transactions and Batched Writes Offline
    • Clear Persistent Offline Data
    • Security and Offline Limitations
    • Offline API Summary
  • Transactions and Batch Writes
    • Overview
    • Prerequisites
    • Transaction Support
    • Batch Writes
    • Field-Level Modifiers
  • Indexing and Performance
    • Overview
    • Automatic Indexes
    • Functional Indexes
    • Compund Query Indexing
    • Collection Group Indexing
    • Join Collection Indexing
    • Index Management
  • Advanced Features
    • Join Collection
      • Join Collection Setup and Prerequisites
    • Collection Group Queries
      • Collection Group Setup and Prerequisites
    • Standalone Duality View
      • Create a Standalone Duality View
    • Snapshot Reads
      • Snapshot Reads Setup and Prerequisites
    • Managing Database Using CLI
  • Security Rules
    • Rule Structure
    • Fixed Variables
    • Operators and Functions
    • Wildcard Rules
    • Macros and Functions
    • Rule Examples
    • Collection Group and Join Collection Rules
    • Best Practices
  • Using Database SDK
    • Supported Features
    • Writing Data: Set Document Examples
      • Writing Data: Add Document Examples
      • Writing Data: Updating Document Examples
    • Reading Data
      • Reading Data Modifiers Examples
      • Reading Data Filter Documents Examples
    • Transaction and Batch Writes Examples
    • Advanced Features
      • Join Collection Examples
      • Collection Group Examples
      • Aggregate Queries Example
  • Errors and Troubleshooting
    • Document Operations Errors
    • Query Errors
    • Transaction and Batch Write Errors
    • Authentication and Security Rule Errors
    • Console-Based Troubleshooting
    • Key Notes
• Part VI Storage
  • Introduction
    • Supported Storage Backends
    • Integration with Authentication
    • Developer Capabilities
  • Storage Setup and Configuration
    • Enabling Object Storage in Console
      • Using DBFS
      • Using OCI Object Storage
    • Backend Selection
    • Application Configuration
    • Security Rules
    • Setting Up Storage Using CLI
  • Object Reference
    • Understanding Object Reference
    • Creating a Reference to a Document
    • Navigating Different Paths Using a Reference
    • Console-Based Path Navigation
  • File Operations
    • Uploading a File
      • Prerequisites
      • Uploading Files Flow
      • Managing and Monitoring Uploads
      • Security Considerations
    • Downloading a File
      • Prerequisites
      • Downloading Files Flow
      • Security Considerations
    • File Management Operations
      • Listing Files
      • Reading File Metadata
      • Deleting a File
      • Directory Operations
      • Console-Based File Management
    • Storage CLI Commands
  • Storage Console Tasks
    • Set Up and Enable Storage Service
    • Upload Files Using Console
    • Download Files Using Console
    • Delete Files Using Console
    • View File Metadata
    • Simulate Folders Using Path Prefixes
  • Using Storage SDK
    • Uploading with JavaScript Storage SDK
      • Uploading a File
        • JavaScript SDK Upload Examples
      • Managing and Monitoring Uploads
        • Managing and Monitoring Uploads Examples
    • Uploading with Flutter Storage SDK
      • Uploading a File
        • Flutter SDK Upload Examples
      • Managing and Monitoring Uploads
        • Managing and Monitoring Uploads Examples
    • Uploading with Java Android Storage SDK
      • Uploading a File
        • Java Android SDK Upload Examples
      • Managing and Monitoring Uploads
        • Managing and Monitoring Uploads Examples
    • Uploading with Swift iOS Storage SDK
      • Uploading a File
        • Swift iOS SDK Upload Examples
      • Managing and Monitoring Uploads
        • Managing and Monitoring Uploads Examples
    • Downloading with Storage SDK
      • Comparison of Download Methods
    • File Management Operations
  • Errors and Troubleshooting
    • Upload Errors
    • Download Errors
    • List Operation Errors
    • Delete Errors
    • Key Notes
• Part VII Security Rules
  • Introduction to Security Rules
    • Purpose and Scope
    • Evaluation Model and Application Scope
    • Key Capabilities
  • Rule Structure and Syntax
    • Rule Definition and Path Matching
    • Supported Methods and Condition Expressions
    • Rule Evaluation and Deployment
  • Fixed Variables and Context Objects
    • Request Context
    • Resource Context
    • Additional Fixed Variables
    • Example Usage
  • Operators and Functions
    • Operators
    • Built-in Functions
  • Macros and Advanced Expressions
    • What are Macros?
    • exists(path) Macro
    • get(path) Macro
    • Dynamic Path Construction
  • Common Rule Patterns and Examples
    • Common Rule Patterns
    • Service-Specific Rule Applications
      • Database Rules
      • Object Storage Rules
      • Authentication Rules
  • Console and SDK Integration
    • Defining Security Rules Using Console
    • Security Rule Example
• Part VIII Vectors
  • Introduction to Vector Support
    • Overview
    • Supported Features
  • Create a Vector Collection
    • Create a Vector Collection Using the Console
      • Vector Column Configuration
      • AUTO_TRIGGER Behavior
      • AUTO_SCHEDULER Behavior
      • Load AI Models to Create Collections for AUTO_TRIGGER and AUTO_SCHEDULER
      • Embedding Generation from URL Sources
      • Console Steps: Creating Collections with Vectors
    • Create a Vector Collection Using SDK APIs
  • Add or Store Embeddings
    • Storing Embeddings Using BYOV
    • Storing Embeddings Using Auto Trigger / Auto Scheduler
  • Indexing
    • Overview
    • Console Steps
  • Using Vectors in Your Application
    • Similarity Search
• Part IX App Trust
  • Introduction to App Trust
    • Overview
    • Request Flow After App Check Activation
    • Supported Platforms and Providers
  • Using App Trust in Your Application
    • Set Up App Trust
      • Console Steps for Setting Up App Trust
    • Initialize App Trust
    • Use Cases
• Part X Getting Ready for Production
  • Route Production Traffic Through a Gateway or Reverse Proxy
    • Configure the Public HTTPS Endpoint
      • Preserve the External HTTPS Context for ORDS
    • Route Requests to ORDS
    • Preserve Required Headers and Request Behavior
    • Apply Production Traffic Controls
    • Understand the Security Layers
• Third-Party License Information