CFCouchbase SDK
  • Introduction
  • What's New With 2.2.0
  • What's New With 2.0.0
  • About This Book
  • Authors
  • Overview
  • Installation
    • ColdBox Module
    • Traditional Apps
  • Configuration
    • Settings
    • Structure
    • Summary
  • Usage
    • Storing Documents
    • Storage Durability
    • Retrieving Documents
    • Data Serialization
    • Components
      • Auto Inflation
      • Manual Inflation
      • Custom Serialization
      • Binary
    • Custom Transformers
    • Executing Queries
      • View Queries
      • n1ql Queries
      • Query Options
      • Filter Closures
      • Transform Closures
      • Return Types
    • Managing Views
    • Working With Futures
  • Help & Support
Powered by GitBook
On this page
  • System Requirements
  • CommandBox Installation

Was this helpful?

Edit on GitHub
Export as PDF

Installation

PreviousOverviewNextColdBox Module

Last updated 7 years ago

Was this helpful?

CFCouchbase ships with the following contents:

  • /cfcouchbase - This is the actual SDK code

  • /apidocs - The API docs that show you the FULL list of SDK methods and their arguments (even ones not covered here). There is also an [Online Version] as well.

  • /samples - A collection of sample apps that use the "beer-sample" bucket.

    • /beer-brewery-manager - Showcases view creation, and basic CRUD operations utilizing native CF data structures

    • /beer-brewery-manager-oo - Same as above but with OO design patterns. Showcases Couchbase CFC inflation

    • /beer-brewery-manager-mvc - Same as above but as an MVC application. Requires a /coldbox mapping on your server.

    • /coldbox-sample - A sample ColdBox application that shows loading CFCouchbase via a module. Requires a /coldbox mapping.

Hint The API Docs also have descriptions and code samples for every method. They are a must read as well!

System Requirements

  • Lucee 4.5+

  • ColdFusion 10+

CommandBox Installation

The easiest way to get started with CFCouchbase is to use to install in any directory:

box install cfcouchbase

This approach can be used for the following application approaches:

CommandBox CLI
ColdBox Module
Traditional ColdFusion Apps