• Couchbase
  • Couchbase Documentation Couchbase Documentation
  • Server
  • Mobile
  • SDKs
Downloads Start Free Trial
Navigation
SDKs
  • .NET SDK
    • Getting Started
      • Start Using the .NET SDK
      • Sample Application
    • Working with Data
      • Key Value Operations
      • Sub-Document Operations
      • Query
      • Analytics
      • Search
      • MapReduce Views
    • Advanced Data Operations
      • Async & React APIs
      • Concurrent Document Mutations
      • Distributed ACID Transactions
      • Encrypting Your Data
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
        • User Management
    • Errors & Diagnostics
      • Handling Errors
      • Logging
      • Slow Operations Logging
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • References
      • .NET API Reference
      • Txns API Reference
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Transactions Release Notes
      • Compatibility
        • Migrating to SDK 3 API
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • C SDK
    • Getting Started
      • Start Using the SDK
      • Sample Application
      • Browser and CLI Access
    • Working with Data
      • Key Value Operations
      • Sub-Document Operations
      • Query
      • Analytics from the SDK
      • Full Text Search from the SDK
      • MapReduce Views
    • Advanced Data Operations
      • Async & Batching APIs
      • Concurrent Document Mutations
      • C++ Distributed ACID Transactions
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
    • Errors & Diagnostics
      • Handling Errors
      • Health Check
      • Logging
      • Observability
        • Slow Operations Logging
        • Metrics Reporting
        • Orphan Requests Logging
        • Request Tracing
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • References
      • API Reference
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Compatibility
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • Go SDK
    • Getting Started
      • Start Using the Go SDK
      • Sample Application
    • Working with Data
      • Key Value Operations
      • Sub-Document Operations
      • Query
      • Analytics
      • Search
      • MapReduce Views
    • Advanced Data Operations
      • Async & Batching APIs
      • Concurrent Document Mutations
      • Encrypting Your Data
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
        • User Management
    • Errors & Diagnostics
      • Handling Errors
        • Slow Operations Logging
      • Health Check
      • Collecting Information & Logging
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • Reference
      • Go API Reference
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Compatibility
        • Migrating to SDK 3 API
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • Kotlin SDK
    • Getting Started
      • Start Using the Kotlin SDK
  • Node.js SDK
    • Getting Started
      • Start Using the Node.js SDK
      • Start Using the Ottoman ODM
      • Sample Application
    • Working with Data
      • Key Value Operations
      • Sub-Document Operations
      • Query
      • Analytics
      • Search
      • MapReduce Views
    • Advanced Data Operations
      • Choosing an API
      • Concurrent Document Mutations
      • Encrypting Your Data
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
        • User Management
    • Errors & Diagnostics
      • Handling Errors
      • Logging
      • Slow Operations Logging
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • References
      • API Reference
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Ottoman Release Notes
      • Compatibility
        • Migrating to SDK 3 API
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • PHP SDK
    • Getting Started!
      • Start Using the PHP SDK
      • Sample Application
    • Working with Data
      • Key Value Operations
      • Sub-Document Operations
      • Query
      • Analytics
      • Full Text Search
      • MapReduce Views
    • Advanced Data Operations
      • Batching
      • Concurrent Document Mutations
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
    • Errors & Diagnostics
      • Handling Errors
      • Logging
        • Slow Operations Logging
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • References
      • PHP API Reference
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Compatibility
        • Migrating to SDK 3 API
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • Python SDK
    • Getting Started
      • Start Using the Python SDK
      • Sample Application
    • Working with Data
      • Key Value Operations
        • Caching Example
      • Sub-Document Operations
      • Query
      • Analytics
      • Full Text Search
      • MapReduce Views
    • Advanced Data Operations
      • Async APIs
      • Concurrent Document Mutations
      • Encrypting Your Data
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
        • User Management
    • Errors & Diagnostics
      • Error Handling
      • Logging
      • Health Check
      • Observability
        • Slow Operations Logging
        • Orphan Requests Logging
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • Reference
      • Python API Reference
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Compatibility
        • Migrating to SDK 3 API
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • Ruby SDK
    • Getting Started!
      • Start Using the Ruby SDK
      • Sample Application
    • Working with Data
      • Key Value Operations
      • Sub-Document Operations
      • Query
      • Analytics
      • Search
      • MapReduce Views
    • Advanced Data Operations
      • Async API
      • Concurrent Document Mutations
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
    • Errors & Diagnostics
      • Handling Errors
      • Logging
      • Slow Operations Logging
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-json Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • Reference
      • Ruby API Reference
      • Client Settings
      • Error Messages
      • Glossary
    • Project Docs
      • Release Notes
      • Compatibility
        • 3rd Party Integrations
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • Scala SDK
    • Getting Started
      • Start Using the SDK
      • Sample Application
    • Working with Data
      • Key Value Operations
      • JSON Libraries
      • Sub-Document Operations
      • Query
      • Search
      • Analytics
      • MapReduce Views
    • Advanced Data Operations
      • Async & Reactive APIs
      • Concurrent Document Mutations
      • Transcoders & Non-JSON
      • Working with Collections
    • Managing Couchbase
      • Managing Connections
        • Authentication
        • Troubleshooting Cloud Connections
      • Provisioning Cluster Resources
    • Errors & Diagnostics
      • Logging
      • Handling Errors
      • Health Check
      • Observability
        • Request Tracing
        • Slow Operations Logging
        • Metrics Reporting
    • Learn
      • Overview
      • Buckets & Clusters
      • Collections & Scope
      • Compression
      • Data Model
        • Documents
        • Non-JSON Docs
        • Sub-Documents
        • XATTR & Virtual XATTR
      • Errors and Diagnostics
        • Health Check
        • Tracing
      • Failure Considerations
      • Field Level Encryption
      • Service Selection
        • Analytics
        • Map Reduce Views
        • Query
        • Search
      • User Management
        • Cert Auth
        • RBAC
    • References
      • API Reference
      • JVM Core IO API
      • Client Settings
      • Error Messages
      • Glossary
      • Travel Sample Data Model
    • Project Docs
      • Release Notes
      • Compatibility
      • Licenses
      • Get involved
        • Improve the Docs
      • About These Docs
  • C++ Transactions
    • C++ Distributed ACID Transactions
      • Transactions Howto
      • Transactions Release Notes
      • API Reference
  • Elasticsearch Connector
    • Elasticsearch Connector
      • Getting Started
      • Configuration
      • Autonomous Operations
      • Monitoring
      • Secure Connections
      • Migration
      • Compatibility
      • Kubernetes
      • Release Notes
    • Elasticsearch Connector
      • Getting Started
      • Configuration
      • Autonomous Operations
      • Monitoring
      • Secure Connections
      • Migration
      • Compatibility
      • Release Notes
    • Elasticsearch Connector
      • Getting Started
      • Configuration
      • Autonomous Operations
      • Monitoring
      • Secure Connections
      • Migration
      • Compatibility
      • Release Notes
    • Elasticsearch Connector
      • Getting Started
      • Configuration
      • Monitoring
      • Secure Connections
      • Migration
      • Compatibility
      • Release Notes
  • Kafka Connector
    • Kafka Connector
      • Quickstart
      • Delivery Guarantees
      • Source Configuration Options
      • Sink Configuration Options
      • Monitoring
      • Couchbase Sample with Kafka Streams
      • Migration Guide
      • Compatibility
      • Couchbase Capella Support
      • Troubleshooting
      • Release Notes
    • Kafka Connector
      • Quickstart
      • Source Configuration Options
      • Sink Configuration Options
      • Monitoring
      • Couchbase Sample with Kafka Streams
      • Migration Guide
      • Compatibility
      • Couchbase Cloud Support
      • Troubleshooting
      • Release Notes
    • Kafka Connector
      • Quickstart
      • Source Configuration Options
      • Sink Configuration Options
      • Couchbase Sample with Kafka Streams
      • Release Notes
  • Spark Connector
    • Spark Connector
      • Download and API Reference
      • Getting Started
      • Development Workflow
      • Working With RDDs
      • Spark SQL Integration
      • Java API
      • Structured Streaming Support
      • Using the Spark Shell
      • Couchbase Cloud Support
      • Configuration
      • Migration Guide
      • Release Notes
    • Spark Connector
      • Download and API Reference
      • Getting Started
      • Development Workflow
      • Working With RDDs
      • Spark SQL Integration
      • Spark Streaming Integration
      • Structured Streaming
      • Java API
      • Using the Spark Shell
      • Release Notes
  • Edit on GitHub

Is this page helpful?

Yes No
Leave Additional Feedback?
Skip

Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

  • Python SDK
  • Project Docs
  • Get involved

Get Involved

    +

    Contributing

    Couchbase welcomes community contributions to the Python SDK. The Python SDK source code is available on GitHub. Please see the CONTRIBUTING file for further information.

    Other Ways to Contribute

    • Join the discussion in our forum and on our Gitter channel.

    • Improve the documentation — bug reports and pull requests are welcome.

    Couchbase
    • Documentation
    • Forums
    • Support
    • Developer Portal
    • Blog
    • Resources
    • Get Started
    • Downloads
    • Training
    • Twitter
    • Linkedin
    • Facebook
    © 2022 Couchbase, Inc. Couchbase, Couchbase Lite and the Couchbase logo are registered trademarks of Couchbase, Inc.
    Terms of Use Privacy Policy Cookie Policy Support Policy Marketing Preference Center