Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • What is Covered in this Documentation?
  • Related Documents
  • Conventions
• Part I Introduction
  • 1 Introduction to Oracle Backend for Firebase
    • 1.1 What is Oracle Backend for Firebase?
    • 1.2 Integration with Oracle AI Database
    • 1.3 Advantages of Using Oracle Backend for Firebase
  • 2 Fundamentals
    • 2.1 Key Terms and Definitions
      • 2.1.1 Generic Terms
      • 2.1.2 Oracle-Specific Terms
    • 2.2 Architecture Overview
    • 2.3 Backend Overview
    • 2.4 Supported Platforms
    • 2.5 SDK Overview
    • 2.6 Console Overview
    • 2.7 CLI Overview
• Part II Setting Up Oracle Backend for Firebase
  • 3 Installing and Configuring Oracle Backend for Firebase
    • 3.1 What You Will Do
    • 3.2 Prerequisites
    • 3.3 Prepare the Database
      • 3.3.1 Check the Database Version and Compatibility Setting
      • 3.3.2 Enable Extended String Support
      • 3.3.3 Configure the TDE Wallet and Master Key
    • 3.4 Enable Oracle Backend for Firebase in ORDS
      • 3.4.1 Verify the ORDS Version
      • 3.4.2 Run the Oracle Backend for Firebase Installer
    • 3.5 Prepare and Enable the Project Schema
      • 3.5.1 Create the Schema
      • 3.5.2 Grant the Required Database Privileges
      • 3.5.3 Enable the Schema for Oracle Backend for Firebase
    • 3.6 Open the Console
    • 3.7 Create Your First Project
    • 3.8 Configure the CLI
      • 3.8.1 Install the CLI from GitHub
      • 3.8.2 Create an OAuth Client for the CLI
      • 3.8.3 Create the CLI Configuration File
      • 3.8.4 Sign In to the CLI
      • 3.8.5 Confirm the CLI Can Reach Your Schema
    • 3.9 Verify the Installation
    • 3.10 Troubleshooting
  • 4 Adding Oracle Backend for Firebase to Your Apps
    • 4.1 Before You Begin
    • 4.2 Introduction
    • 4.3 Choose Your Platform
    • 4.4 Add Oracle Backend for Firebase to a Web App
      • 4.4.1 Prerequisites
      • 4.4.2 Register Your Web App
      • 4.4.3 Install the JavaScript SDK
      • 4.4.4 Initialize the JavaScript SDK
      • 4.4.5 Next Steps
    • 4.5 Add Oracle Backend for Firebase to an iOS App
      • 4.5.1 Prerequisites
      • 4.5.2 Register Your iOS App
      • 4.5.3 Add the App Configuration
      • 4.5.4 Add the iOS SDK
      • 4.5.5 Configure the URL Scheme for Social Login
      • 4.5.6 Initialize the iOS SDK
      • 4.5.7 Other Installation Options
      • 4.5.8 Next Steps
    • 4.6 Add Oracle Backend for Firebase to an Android App
      • 4.6.1 Prerequisites
      • 4.6.2 Java Android SDK Installation
      • 4.6.3 Add the App Configurations
      • 4.6.4 Add the Android SDK
      • 4.6.5 Configure Android for Network Access and Social Login
      • 4.6.6 Initialize the Android SDK
      • 4.6.7 Other Installation Options
      • 4.6.8 Next Steps
    • 4.7 Add Oracle Backend for Firebase to a Flutter App
      • 4.7.1 Prerequisites
      • 4.7.2 Register Your Flutter App
      • 4.7.3 Flutter SDK Installation
      • 4.7.4 Flutter SDK Initialization
      • 4.7.5 Configure Android for Social Login Redirects
      • 4.7.6 Other Installation Options
      • 4.7.7 Next Steps
    • 4.8 Troubleshooting
    • 4.9 Next Steps
• Part III Setting Up and Managing Projects
  • 5 Setting Up Oracle Backend for Firebase Projects
    • 5.1 Introduction to Projects
    • 5.2 Why Projects Matter
      • 5.2.1 Working with a Project (Console or CLI)
    • 5.3 How Projects Relate to Applications and Services
    • 5.4 What a Project Contains
    • 5.5 Ownership, Access, and Boundaries
    • 5.6 Database Roles and Project Roles
    • 5.7 Administrative Preparation Before Project Creation
    • 5.8 Application Registration Within a Project
    • 5.9 App Configuration and Project Configuration
    • 5.10 Managing a Project in Practice
      • 5.10.1 Creating a Project
      • 5.10.2 Managing Projects Using the Console and CLI
      • 5.10.3 Assigning Project Roles to Other Users
      • 5.10.4 Syncing Project Data
      • 5.10.5 Revoking Project Access
      • 5.10.6 Deleting a Project
    • 5.11 Project Limitations and Operational Considerations
  • 6 Managing Projects
    • 6.1 Working with Projects
      • 6.1.1 Viewing Your Project Information
    • 6.2 Managing Project Members
      • 6.2.1 Prerequisites
      • 6.2.2 Updating Member Roles
• Part IV Authentication
  • 7 Oracle Backend for Firebase Authentication
    • 7.1 Overview
    • 7.2 Key Capabilities
    • 7.3 App Users
    • 7.4 Using Auth in your App
    • 7.5 What is Authentication
  • 8 Authenticating Application Users
    • 8.1 App Users
    • 8.2 Basic Properties
    • 8.3 Sign-In Methods
    • 8.4 Authentication Flow
    • 8.5 Current User and Auth Listeners
    • 8.6 Application User Self-service
    • 8.7 Email Verification and Password Reset
      • 8.7.1 SMTP Configuration
      • 8.7.2 Email Verification
      • 8.7.3 Password Reset
    • 8.8 Auth Tokens
      • 8.8.1 Auth Token Example
      • 8.8.2 Auth Token Fields
    • 8.9 Managing Application Users
    • 8.10 JSON Web Key
  • 9 Authentication Types
    • 9.1 Basic Authentication
    • 9.2 LDAP Authentication
    • 9.3 IDCS Authentication
    • 9.4 Which Path is Right for Me?
  • 10 Setting Up Authentication
    • 10.1 Prerequisites
    • 10.2 Enabling Authentication for a Project
    • 10.3 Basic Authentication Setup
    • 10.4 LDAP Authentication Setup
    • 10.5 IDCS Authentication Setup
    • 10.6 Setting Up Third-Party Identity Providers
      • 10.6.1 Set up Social Sign-in (GitHub, Google, and more)
      • 10.6.2 Configuring OIDC and SAML Identity Providers
    • 10.7 Configuring SMTP for Email Verification and Password Reset
    • 10.8 Defining Password Policies
    • 10.9 Changing Authentication Providers
      • 10.9.1 Switching Authentication Providers
    • 10.10 Setting Up and Managing Authentication Using CLI
    • 10.11 Authorized Domains
  • 11 Getting Started with Authentication SDK
    • 11.1 Prerequisites
    • 11.2 Getting Started
    • 11.3 Pre-built UI
      • 11.3.1 Using Pre-built UI
    • 11.4 User Management Operations
    • 11.5 Email Verification and Reset Password
    • 11.6 Third-Party Identity Providers
      • 11.6.1 Web Sign-In Flow
      • 11.6.2 Android Sign-In Flows
      • 11.6.3 iOS Sign-In Flows
    • 11.7 Link Social Accounts
      • 11.7.1 Unlink Social Accounts
    • 11.8 Persistence Settings
    • 11.9 Rate Limiting for Public Authentication Flows
  • 12 Errors and Troubleshooting
    • 12.1 Authentication Error Format
    • 12.2 Common Authentication Errors
• Part V Database
  • 13 Introduction
    • 13.1 Overview
    • 13.2 Key Terms
    • 13.3 Data Models
    • 13.4 What You Will Learn in This Section
    • 13.5 How to Use This Section
  • 14 Data Model
    • 14.1 Document-Collection Model
    • 14.2 Relational-to-Collection Mapping
    • 14.3 Standalone Duality Views (Advanced)
    • 14.4 Hierarchical Structure and Subcollections
    • 14.5 Supported Data Types
  • 15 Getting Started and Console Check
    • 15.1 Overview
    • 15.2 Create a Project and Register an App
    • 15.3 Import and Initialize the SDK
    • 15.4 Write a Document
    • 15.5 Read it Back
    • 15.6 Secure the Collection
    • 15.7 Check the Console
  • 16 Managing Collections
    • 16.1 Prerequisites for Collection Management
    • 16.2 Collections and Documents
    • 16.3 Creating a Collection
    • 16.4 Dropping a Collection
    • 16.5 Getting a Collection List
  • 17 Document Operations
    • 17.1 Prerequisites
    • 17.2 Write Operations
      • 17.2.1 Supported Document Operations
        • 17.2.1.1 Set a Document
          • 17.2.1.1.1 Example: Set a Document with Merge Options
        • 17.2.1.2 Add a Document
        • 17.2.1.3 Update a Document
        • 17.2.1.4 Delete a Document
      • 17.2.2 Field-Level Semantics and Data Types
      • 17.2.3 Security Rule Enforcement
    • 17.3 Read Operations
      • 17.3.1 Supported Read Operations
      • 17.3.2 Query Capabilities and Semantics
        • 17.3.2.1 Filtering with Conditions
        • 17.3.2.2 Ordering and Pagination
        • 17.3.2.3 Collection Group and Join Queries
        • 17.3.2.4 Aggregation Functions
  • 18 Transactions and Batch Writes
    • 18.1 Overview
    • 18.2 Prerequisites
    • 18.3 Transaction Support
    • 18.4 Batch Writes
    • 18.5 Field-Level Modifiers
  • 19 Indexing and Performance
    • 19.1 Overview
    • 19.2 Automatic Indexes
    • 19.3 Functional Indexes
    • 19.4 Compund Query Indexing
    • 19.5 Collection Group Indexing
    • 19.6 Join Collection Indexing
    • 19.7 Index Management
  • 20 Advanced Features
    • 20.1 Join Collection
      • 20.1.1 Join Collection Setup and Prerequisites
    • 20.2 Collection Group Queries
      • 20.2.1 Collection Group Setup and Prerequisites
    • 20.3 Standalone Duality View
      • 20.3.1 Standalone Duality View Setup and Creation
    • 20.4 Snapshot Reads
      • 20.4.1 Snapshot Reads Setup and Prerequisites
    • 20.5 Managing Database Using CLI
  • 21 Security Rules
    • 21.1 Rule Structure
    • 21.2 Fixed Variables
    • 21.3 Operators and Functions
    • 21.4 Wildcard Rules
    • 21.5 Macros and Functions
    • 21.6 Rule Examples
    • 21.7 Collection Group and Join Collection Rules
    • 21.8 Best Practices
  • 22 Using Database SDK
    • 22.1 Supported Features
    • 22.2 Writing Data: Set Document Examples
      • 22.2.1 Writing Data: Add Document Examples
      • 22.2.2 Writing Data: Updating Document Examples
    • 22.3 Reading Data
      • 22.3.1 Reading Data Modifiers Examples
      • 22.3.2 Reading Data Filter Documents Examples
    • 22.4 Transaction and Batch Writes Examples
    • 22.5 Advanced Features
      • 22.5.1 Join Collection Examples
      • 22.5.2 Collection Group Examples
      • 22.5.3 Aggregate Queries Example
  • 23 Errors and Troubleshooting
    • 23.1 Document Operations Errors
    • 23.2 Query Errors
    • 23.3 Transaction and Batch Write Errors
    • 23.4 Authentication and Security Rule Errors
    • 23.5 Console-Based Troubleshooting
    • 23.6 Key Notes
• Part VI Storage
  • 24 Introduction
    • 24.1 Supported Storage Backends
    • 24.2 Integration with Authentication
    • 24.3 Developer Capabilities
  • 25 Storage Setup and Configuration
    • 25.1 Enabling Object Storage in Console
      • 25.1.1 Using DBFS
      • 25.1.2 Using OCI Object Storage
    • 25.2 Backend Selection
    • 25.3 Application Configuration
    • 25.4 Security Rules
    • 25.5 Setting Up Storage Using CLI
  • 26 Object Reference
    • 26.1 Understanding Object Reference
    • 26.2 Creating a Reference to a Document
    • 26.3 Navigating Different Paths Using a Reference
    • 26.4 Console-Based Path Navigation
  • 27 File Operations
    • 27.1 Uploading a File
      • 27.1.1 Prerequisites
      • 27.1.2 Uploading Files Flow
      • 27.1.3 Managing and Monitoring Uploads
      • 27.1.4 Security Considerations
    • 27.2 Downloading a File
      • 27.2.1 Prerequisites
      • 27.2.2 Downloading Files Flow
      • 27.2.3 Security Considerations
    • 27.3 File Management Operations
      • 27.3.1 Listing Files
      • 27.3.2 Reading File Metadata
      • 27.3.3 Deleting a File
      • 27.3.4 Directory Operations
      • 27.3.5 Console-Based File Management
    • 27.4 Storage CLI Commands
  • 28 Storage Console Tasks
    • 28.1 Set Up and Enable Storage Service
    • 28.2 Upload Files Using Console
    • 28.3 Download Files Using Console
    • 28.4 Delete Files Using Console
    • 28.5 View File Metadata
    • 28.6 Simulate Folders Using Path Prefixes
  • 29 Using Storage SDK
    • 29.1 Uploading with JavaScript Storage SDK
      • 29.1.1 Uploading a File
        • 29.1.1.1 JavaScript SDK Upload Examples
      • 29.1.2 Managing and Monitoring Uploads
        • 29.1.2.1 Managing and Monitoring Uploads Examples
    • 29.2 Uploading with Flutter Storage SDK
      • 29.2.1 Uploading a File
        • 29.2.1.1 Flutter SDK Upload Examples
      • 29.2.2 Managing and Monitoring Uploads
        • 29.2.2.1 Managing and Monitoring Uploads Examples
    • 29.3 Uploading with Java Android Storage SDK
      • 29.3.1 Uploading a File
        • 29.3.1.1 Java Android SDK Upload Examples
      • 29.3.2 Managing and Monitoring Uploads
        • 29.3.2.1 Managing and Monitoring Uploads Examples
    • 29.4 Uploading with Swift iOS Storage SDK
      • 29.4.1 Uploading a File
        • 29.4.1.1 Swift iOS SDK Upload Examples
      • 29.4.2 Managing and Monitoring Uploads
        • 29.4.2.1 Managing and Monitoring Uploads Examples
    • 29.5 Downloading with Storage SDK
      • 29.5.1 Comparison of Download Methods
    • 29.6 File Management Operations
  • 30 Errors and Troubleshooting
    • 30.1 Upload Errors
    • 30.2 Download Errors
    • 30.3 List Operation Errors
    • 30.4 Delete Errors
    • 30.5 Key Notes
• Part VII Security Rules
  • 31 Introduction to Security Rules
    • 31.1 Purpose and Scope
    • 31.2 Evaluation Model and Application Scope
    • 31.3 Key Capabilities
  • 32 Rule Structure and Syntax
    • 32.1 Rule Definition and Path Matching
    • 32.2 Supported Methods and Condition Expressions
    • 32.3 Rule Evaluation and Deployment
  • 33 Fixed Variables and Context Objects
    • 33.1 Request Context
    • 33.2 Resource Context
    • 33.3 Additional Fixed Variables
    • 33.4 Example Usage
  • 34 Operators and Functions
    • 34.1 Operators
    • 34.2 Built-in Functions
  • 35 Macros and Advanced Expressions
    • 35.1 What are Macros?
    • 35.2 exists(path) Macro
    • 35.3 get(path) Macro
    • 35.4 Dynamic Path Construction
  • 36 Common Rule Patterns and Examples
    • 36.1 Common Rule Patterns
    • 36.2 Service-Specific Rule Applications
      • 36.2.1 Database Rules
      • 36.2.2 Object Storage Rules
      • 36.2.3 Authentication Rules
  • 37 Console and SDK Integration
    • 37.1 Defining Security Rules Using Console
    • 37.2 Security Rule Example
• Part VIII Vectors
  • 38 Introduction to Vector Support
    • 38.1 Overview
    • 38.2 Supported Features
  • 39 Create a Vector Collection
    • 39.1 Create a Vector Collection Using the Console
      • 39.1.1 Vector Column Configuration
      • 39.1.2 AUTO_TRIGGER Behavior
      • 39.1.3 AUTO_SCHEDULER Behavior
      • 39.1.4 Load AI Models to Create Collections for AUTO_TRIGGER and AUTO_SCHEDULER
      • 39.1.5 Embedding Generation from URL Sources
      • 39.1.6 Console Steps: Creating Collections with Vectors
    • 39.2 Create a Vector Collection Using SDK APIs
  • 40 Add or Store Embeddings
    • 40.1 Storing Embeddings Using BYOV
    • 40.2 Storing Embeddings Using Auto Trigger / Auto Scheduler
  • 41 Indexing
    • 41.1 Overview
    • 41.2 Console Steps
  • 42 Using Vectors in Your Application
    • 42.1 Similarity Search
• Part IX App Trust
  • 43 Introduction to App Trust
    • 43.1 Overview
    • 43.2 Request Flow After App Check Activation
    • 43.3 Supported Platforms and Providers
  • 44 Using App Trust in Your Application
    • 44.1 Set Up App Trust
      • 44.1.1 Console Steps for Setting Up App Trust
    • 44.2 Initialize App Trust
    • 44.3 Use Cases
• Part X Getting Ready for Production
  • 45 Route Production Traffic Through a Gateway or Reverse Proxy
    • 45.1 Configure the Public HTTPS Endpoint
      • 45.1.1 Preserve the External HTTPS Context for ORDS
    • 45.2 Route Requests to ORDS
    • 45.3 Preserve Required Headers and Request Behavior
    • 45.4 Apply Production Traffic Controls
    • 45.5 Understand the Security Layers
• A Third-Party License Information