All Classes and Interfaces
Class
Description
Base class for Spring Data Couchbase configuration using JavaConfig.
An abstract
CouchbaseConverter that provides the basics for the MappingCouchbaseConverter.Base class to implement domain class specific
ApplicationListeners.RepositoryQuery implementation for Couchbase.RepositoryQuery implementation for Couchbase.renamed from AbstractCouchbaseQuery to AbstractCouchbaseQueryDSL to avoid confusion with the AbstractCouchbaseQuery
that is in the package com.querydsl.couchbase
Abstract base for all Couchbase
RepositoryQuery.Base class for reactive
RepositoryQuery implementations for Couchbase.Base shared by Reactive and non-Reactive TemplateSupport
Callback being invoked after a domain object is materialized from a
CouchbaseDocument when reading results.A common interface for those that support one(T), all(Collection<T>)
A common interface for those that support one(T), all(Collection<T%gt;)
EntityCallback to populate auditing related fields on an entity about to be saved.Event listener to populate auditing related fields on an entity about to be saved.
A default
PointInShapeEvaluator implementation based on the JDK's java.awt.geom classes.The representation of a persistent entity.
Implements annotated property representations of a given
Field instance.BasicQuery for Querydsl
Contains default bean names for Couchbase beans.
Callback being invoked before a domain object is converted to be persisted.
Reading Converter factory for Enums.
CacheKeyPrefix provides a hook for creating custom prefixes prepended to the actual key stored in
Couchbase.Collection Annotation
Defines the callback which will be wrapped and executed on a bucket.
Enumeration of different consistency configurations to be used by the queries generated by the framework.
A common interface for those that support withOptions()
PropertyValueConverter throws this when cannot convert the property.
An
Iterator<Object> that converts
values to their stored Class if warranted.Annotation processor to create Querydsl query types for QueryDsl annotated classes.
A support registrar that allows to set up auditing for Couchbase (including
AuditingHandler and {
IsNewStrategyFactory} set up).The Couchbase transaction manager, providing support for @Transactional methods.
The
CouchbaseClientFactory is the main way to get access to the managed SDK instance and resources.ValueConversionContext that allows to delegate read/write to an underlying CouchbaseConverter.Marker interface for the converter, identifying the types to and from that can be converted.
Value object to capture custom conversion.
CouchbaseCustomConversions.CouchbaseConverterConfigurationAdapter encapsulates creation of
CustomConversions.ConverterConfiguration with CouchbaseDB specifics.A Couchbase specific integrity violation exception, thrown as a result of failing db operations.
A
CouchbaseDocument is an abstract representation of a document stored inside Couchbase Server.A property accessor for document properties.
Serializes the given Querydsl query to a Document query for Couchbase.
Marker interface for the Couchbase Entity Information.
Simple
PersistenceExceptionTranslator for Couchbase.Helper class to register JSR-310 specific
Converter implementations.A
CouchbaseList is an abstract list that represents an array stored in a (most of the times JSON) document.Default implementation of a
MappingContext for Couchbase using
BasicCouchbasePersistentEntity and BasicCouchbasePersistentProperty as primary abstractions.A mapping event.
Defines common operations on the Couchbase data source, most commonly implemented by
CouchbaseTemplate.Extend PartTree to parse out distinct fields
Represents an entity that can be persisted which contains 0 or more properties.
Represents a property part of an entity that needs to be persisted.
Accept the Couchbase @Encrypted and @JsonValue annotations in addition to @ValueConverter annotation.
There can only be one propertyValueConverter for a property.
There can only be one propertyValueConverter for a property.
An
DataRetrievalFailureException that denotes an error during a query (N1QL).Represents a query method with couchbase extensions, allowing to discover if View-based query or N1QL-based query
must be used.
Couchbase specific
Repository interface.Common base for SimpleCouchbaseRepository and SimpleReactiveCouchbaseRepository
A bean which represents a Couchbase repository.
A portable CDI extension which registers beans for Spring Data Couchbase repositories.
Factory to create
SimpleCouchbaseRepository instances.The factory bean to create repositories.
Deprecated.
Container for couchbase transaction resources to hold in threadlocal or reactive context.
Marker Interface to identify either a
CouchbaseDocument or a CouchbaseList.Implements lower-level couchbase operations on top of the SDK with entity mapping capabilities.
The TransactionalOperator interface is another method to perform reactive transactions with Spring.
Couchbase Transaction Definition for Spring Data transaction framework.
This allows reactive @Transactional support with Couchbase transactions.
Couchbase transaction status for Spring Data transaction framework.
Marker interface for the TypeMapper.
Marker interface for the Couchbase
EntityWriter.An utility entity that allows to extract total row count out of a COUNT(*) N1QL query.
RepositoryProxyPostProcessor that sets up interceptors to read metadata information from the invoked method.Encrypt/Decrypted properties annotated.
Deprecated.
Out of the box conversions for java dates and calendars.
DB references
The Couchbase Type Mapper.
Deprecated.
Identifies a domain object to be persisted to Couchbase.
Durability annotation
Invocation Handler for scope/collection/options proxy for repositories
The generic parameter needs to be REPO which is either a CouchbaseRepository parameterized on T,ID or a
ReactiveCouchbaseRepository parameterized on T,ID. i.e.: interface AirportRepository extends
CouchbaseRepository<Airport, String>, DynamicProxyable<AirportRepository>
Annotation to enable auditing in Couchbase via annotation configuration.
Annotation to activate Couchbase repositories.
Annotation to enable auditing in Couchbase using reactive infrastructure via annotation
configuration.
Annotation to activate reactive couchbase repositories.
Insert Operations
Provides methods for constructing KV exists operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
FindByAnalytics Operations
Deprecated.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Result type override (Optional).
Get Operations
Provides methods for constructing query operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
Query Operations
Provides methods for constructing query operations in a fluent way.
Deprecated.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify scan consistency.
Fluent method to specify DISTINCT fields
Fluent method to specify options.
Fluent method to specify fields to project.
Fluent method to specify a return type different than the the entity type to use for the results.
Fluent methods to specify the query
Terminating operations invoking the actual execution.
ExecutableFindByQueryOperation implementations for Couchbase.Query Operations
Provides methods for constructing get operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual get execution.
Insert Operations
Provides methods for constructing KV insert operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
Mutate In Operations
Provides methods for constructing KV operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
ExecutableMutateInByIdOperation implementations for Couchbase.Get Operations
Provides methods for constructing query operations in a fluent way.
Fluent method to specify scan consistency.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Fluent method to specify a return type different than the the entity type to use for the results.
Terminating operations invoking the actual execution.
Remove Operations on KV service.
Provides methods for constructing remove operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
ExecutableRemoveByIdOperation implementations for Couchbase.RemoveBy Query Operations
Provides methods for constructing query operations in a fluent way.
Deprecated.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Fluent methods to specify the query
Terminating operations invoking the actual execution.
Replace Operations
Provides methods for constructing KV replace operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
Insert Operations
Provides methods for constructing KV operations in a fluent way.
Terminating operations invoking the actual execution.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Annotation to define a field to be substituted for META().expiration in a query
Expiry annotation
Setting for specify when to fetch the associated entities
Annotation to define custom metadata for document fields.
From jonskeet.uk as provided in https://groups.google.com/g/comp.lang.java.programmer/c/khq5GGXIzC4
The fluent couchbase operations combines all different possible operations for simplicity reasons.
This annotation is targeted at
Document interfaces, indicating that the framework should generate the
document key value using the specified generatorKeys generation strategy
Utility class to deal with geo/dimensional indexed data and queries.
Hash side to specify hash join.
This annotation is targeted at building the document id using the attribute value.
This annotation is targeted at building the document id using the value as a part of a prefix build.
This annotation is targeted at building the document id using the value as a part of a suffix build.
A common interface for all of Insert, Replace, Upsert that take Collection
A common interface for all of Insert, Replace, Upsert that take options
Reading Converter factory for Enums.
A Jackson JSON Translator that implements the
TranslationService contract.Converter for non-Enum types that have @JsonValue and possibly an @JsonCreator annotated methods.
Common settings for Couchbase key - prefix - suffix - delimiter
A
ApplicationListener for Couchbase mapping events logging the events.A mapping converter for Couchbase.
Entity Information container.
Meta-data for
Query instances.A N1QL Query Expression
This annotation is targeted for entity field which is a list of the associated entities fetched by ANSI Join across
the entities available from Couchbase Server 5.5
N1qlJoinResolver resolves by converting the join definition to query statement and executing using CouchbaseTemplate
N1qlMutateQueryCreator allows to create queries for delete operations.
Deprecated.
Utils for creating part tree expressions
Deprecated.
Deprecated.
Utility class to deal with constructing well formed N1QL queries around Spring Data entities, so that the framework
can use N1QL to find such entities (eg. restrict the bucket search to a particular type).
Wrapper of
TemplateSupport methods to adapt them to ReactiveTemplateSupport.This
Query Creator is responsible for parsing a PartTree (representing a method
name) into the WHERE clause of a N1QL query.A common interface for those that support one(T), all(Collection<T>)
A common interface for those that support one(T), all(Collection<T>)
A common interface for those that support one(T), all(Collection<T>)
A common interface for those that support one(T), all(Collection<T>)
A common interface for those that support one(T), all(Collection<T>)
A common interface for those that support one(String), all(Collection<String>)
A common interface for those that support one(String), all(Collection<String>)
A common interface for those that support one(T), all(Collection<T>)
Data Access Exception that identifies Operations cancelled while being processed.
Data Access Exception that identifies Operations interrupted while being processed.
Scope Annotation
Methods for building Options objects for Couchbae APIs.
Out of the box conversions for Other types.
Writing converter for Enums.
RepositoryQuery implementation for Couchbase.Deprecated.
A Part Tree Query creator for Couchbase
Determine the arguments to be used in the operation from various sources
Annotation to support the use of N1QL queries with Couchbase.
Couchbase-specific
QuerydslPredicateExecutor that allows execution Predicates in various forms.Mark a field to be indexed by the query engine.
QueryIndexResolver finds those IndexDefinitions to be created for a given class.Callback being invoked after a domain object is materialized from a
CouchbaseDocument when reading results.Reactive
EntityCallback to populate auditing related fields on an entity about to be saved.Callback being invoked before a domain object is converted to be persisted.
Defines common operations on the Couchbase data source, most commonly implemented by
ReactiveCouchbaseTemplate.Reactive
ParametersParameterAccessor implementation that subscribes
to reactive parameter wrapper types upon creation.Reactive specific implementation of
CouchbaseQueryMethod.Couchbase-specific
ReactiveSortingRepository implementation.Deprecated.
template class for Reactive Couchbase operations
Exists Operations
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Provides methods for constructing KV exists operations in a fluent way.
Terminating operations invoking the actual execution.
ReactiveExistsById Support
FindByAnalytics Operations
Deprecated.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Result type override (Optional).
Terminating operations invoking the actual execution.
Get Operations
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Provides methods for constructing query operations in a fluent way.
Terminating operations invoking the actual execution.
ReactiveFindByIdOperation implementations for Couchbase.ReactiveFindByQueryOperation
Queries the N1QL service.
Queries the N1QL service.
Deprecated.
Fluent method to specify the collection
Fluent method to specify the scope
Fluent method to specify scan consistency.
Fluent method to specify DISTINCT fields
Fluent method to specify options.
Fluent method to specify fields to project.
Fluent method to specify a return type different than the the entity type to use for the results.
Fluent methods to filter by query
provides methods for constructing query operations in a fluent way.
Compose find execution by calling one of the terminating methods.
ReactiveFindByQueryOperation implementations for Couchbase.Find by id from replicas Operations
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Provides methods for constructing get operations in a fluent way.
Terminating operations invoking the actual get execution.
ReactiveFindFromReplicasByIdOperation implementations for Couchbase.The fluent couchbase operations combines all different possible operations for simplicity reasons.
Insert Operations
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Provides methods for constructing KV insert operations in a fluent way.
Terminating operations invoking the actual execution.
ReactiveInsertByIdOperation implementations for Couchbase.Mutate In Operations
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Provides methods for constructing KV operations in a fluent way.
Terminating operations invoking the actual execution.
ReactiveMutateInByIdOperation implementations for Couchbase.Deprecated.
Reactive PartTree
RepositoryQuery implementation for Couchbase.Deprecated.
Get Operations
Fluent method to specify scan consistency.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Fluent method to specify a return type different than the the entity type to use for the results.
Provides methods for constructing query operations in a fluent way.
Terminating operations invoking the actual execution.
Remove Operations on KV service.
Provides methods for constructing remove operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
ReactiveRemoveByIdOperation implementations for Couchbase.RemoveBy Query Operations
Provides methods for constructing query operations in a fluent way.
Deprecated.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Fluent methods to specify the query
Terminating operations invoking the actual execution.
ReactiveRemoveByQueryOperation implementations for Couchbase.ReplaceOperations
Provides methods for constructing KV replace operations in a fluent way.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
Terminating operations invoking the actual execution.
ReactiveReplaceByIdOperation implementations for Couchbase.Query to use a plain JSON String to create the
Query to actually execute.ReactiveTemplateSupport
Upsert Operations
Provides methods for constructing KV operations in a fluent way.
Terminating operations invoking the actual execution.
Fluent method to specify the collection.
Fluent method to specify the scope.
Fluent method to specify options.
ReactiveUpsertByIdOperation implementations for Couchbase.A utility class for configuration allowing to tell which
CouchbaseOperations should be backing repositories.Scan Consistency Annotation
Scope Annotation
The default implementation of a
CouchbaseClientFactory.Repository base implementation for Couchbase.
Reactive repository base implementation for Couchbase.
Custom
CouchbaseDocumentSerializer to take mapping information into account when building keys for
constraints.Query to use a plain JSON String to create the
Query to actually execute.This class is exposed to SpEL parsing through the variable
#"n1ql".Query created from the string in @Query annotation in the repository interface.
Reading Converter factory for Enums.
Utility methods to support transactions.
A transaction rollback has been requested.
The transaction expired at the point of trying to commit it.
A base class of transaction-level exceptions raised by Couchbase, allowing them to be handled in one place.
The transaction failed and unambiguously did not commit.
Defines a translation service to encode/decode responses into the
CouchbaseStorable format.TypeAwareTypeInformationMapper - leverages @TypeAlias
An opaque signal that something went wrong during the execution of an operation inside a transaction.
A
NonTransientDataAccessException that denotes that a particular feature is expected on the server side but
is not available.Utility class for Couchbase Repository
javax.validation dependant entities validator.
Deprecated.
Deprecated.
Interface to abstract
ViewMetadataProvider that provides Views to be used for query execution.RepositoryProxyPostProcessor that sets up an interceptor to read View information from the invoked
method.Interface for operations that take AnalyticsScanConsistency
Interface for operations that take AnalyticsOptions
Interface for operations that take AnalyticsQuery
A common interface for those that support withBatchByteLimit()
A common interface for those that support withBatchItemLimit()
Annotation to set the scan consistency of N1QL queries with Couchbase.
A common interface operations that take scan consistency
Interface for operations that take distinct fields
A common interface for all of Insert, Replace, Upsert that take Durability
Interface for operations that take ExistsOptions
A common interface for those that support withExpiry()
A interface for operations that take GetAnyReplicaOptions
Interface for operations that take GetOptions
Interface for operations take insert options
A common interface for those that support withLock()
A common interface for all of Insert, Replace, Upsert mutations that take options.
A common interface for all of Insert, Replace, Upsert and Remove mutations that take options.
A common interface for all of Insert, Replace, Upsert that take Projection
A common interface for all of Insert, Replace, Upsert that take Projection
A common interface for those that support project()
A common interface for all of Insert, Replace, Upsert that take Query
A common interface for all of Insert, Replace, Upsert that take options
A common interface for all of Insert, Replace, Upsert that take options
A common interface for all of Insert, Replace, Upsert that take options
A common interface for those that support withOptions()
A common interface for those that support withOptions()
A common interface for all of Insert, Replace, Upsert that take options
CouchbaseCustomConversions.