RxDatastoreClient (GORM for Rx 8.1.2)

org.grails.datastore.mapping.config.Settings

All Superinterfaces:

ConnectionSourcesProvider<T, ConnectionSourceSettings>, QueryCreator, Settings
```
interface RxDatastoreClient<T>
extends java.io.Closeable, ConnectionSourcesProvider<T, ConnectionSourceSettings>, QueryCreator, Settings
```
Represents a client connection pool that can be used to interact with a backing implementation in RxGORM
Authors:
Graeme Rocher
Since:
6.0
Parameters:
The - native client interface

Inherited fields
Fields inherited from class	Fields
`interface Settings`	`PREFIX, SETTING_AUTO_FLUSH, SETTING_CUSTOM_TYPES, SETTING_DATASOURCE, SETTING_DATASOURCES, SETTING_DB_CREATE, SETTING_DEFAULT_CONSTRAINTS, SETTING_DEFAULT_MAPPING, SETTING_FAIL_ON_ERROR, SETTING_FLUSH_MODE, SETTING_MARK_DIRTY, SETTING_MULTI_TENANCY_MODE, SETTING_MULTI_TENANT_RESOLVER, SETTING_MULTI_TENANT_RESOLVER_CLASS`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`abstract Query`	`createQuery(java.lang.Class type)` Creates a query for the given type
	`abstract Query`	`createQuery(java.lang.Class type, java.util.Map arguments)` Creates a query for the given type
	`abstract rx.Observable<java.lang.Boolean>`	`delete(java.lang.Object instance)` Deletes an instance
	`abstract rx.Observable<java.lang.Boolean>`	`delete(java.lang.Object instance, java.util.Map<java.lang.String, java.lang.Object> arguments)` Deletes an instance
	`abstract rx.Observable<java.lang.Number>`	`deleteAll(java.lang.Iterable instances)` Deletes a number of instances
	`abstract rx.Observable<java.lang.Number>`	`deleteAll(java.lang.Iterable instances, java.util.Map<java.lang.String, java.lang.Object> arguments)` Deletes a number of instances
`<T1>`	`abstract rx.Observable<T1>`	`get(java.lang.Class<T1> type, java.io.Serializable id)` Obtains a single instance for the given type and id
	`abstract ConnectionSources<T, ConnectionSourceSettings>`	`getConnectionSources()` Returns: Obtain the connection sources
	`abstract RxDatastoreClient`	`getDatastoreClient(java.lang.String connectionSourceName)` Obtain another RxDatastoreClient for the given ConnectionSource name
	`abstract RxDatastoreClient`	`getDatastoreClientForTenantId(java.io.Serializable tenantId)` Obtains the datastore for the given tenant id.
	`abstract ConfigurableApplicationEventPublisher`	`getEventPublisher()` Returns: The event publisher
	`abstract MappingContext`	`getMappingContext()` Returns: The mapping context
	`abstract MultiTenancyMode`	`getMultiTenancyMode()` Returns: The multi tenancy mode
	`abstract T`	`getNativeInterface()` Returns: The native interface to the datastore
	`abstract TenantResolver`	`getTenantResolver()` Returns: Obtain the tenant resolver
`<T1>`	`abstract rx.Observable<T1>`	`insert(T1 instance, java.util.Map<java.lang.String, java.lang.Object> arguments)` Force an insert of an instance and return the observable
	`abstract rx.Observable<java.util.List<java.io.Serializable>>`	`insertAll(java.lang.Iterable objects)` Batch insert all all of the given objects
	`abstract rx.Observable<java.util.List<java.io.Serializable>>`	`insertAll(java.lang.Iterable objects, java.util.Map<java.lang.String, java.lang.Object> arguments)` Batch insert all all of the given objects
`<T1>`	`abstract rx.Observable<T1>`	`persist(T1 instance, java.util.Map<java.lang.String, java.lang.Object> arguments)` Persist and instance and return the observable
`<T1>`	`abstract rx.Observable<T1>`	`persist(T1 instance)` Persist and instance and return the observable
	`abstract rx.Observable<java.util.List<java.io.Serializable>>`	`persistAll(java.lang.Iterable objects)` Batch saves all of the given objects
	`abstract rx.Observable<java.util.List<java.io.Serializable>>`	`persistAll(java.lang.Iterable objects, java.util.Map<java.lang.String, java.lang.Object> arguments)` Batch saves all of the given objects
`<T1>`	`abstract ObservableProxy<T1>`	`proxy(java.lang.Class<T1> type, java.io.Serializable id)` Obtain an ObservableProxy for the given type and id
	`abstract ObservableProxy`	`proxy(Query query)` Obtain an ObservableProxy that executes the given query to initialize

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface java.io.Closeable`	`java.io.Closeable#close()`
`interface QueryCreator`	`createQuery, isSchemaless`

- Method Detail
  - abstract Query createQuery(java.lang.Class type)
    
    Creates a query for the given type
    Parameters:
    type - The type
    Returns:
    The query
  - abstract Query createQuery(java.lang.Class type, java.util.Map arguments)
    
    Creates a query for the given type
    Parameters:
    type - The type
    Returns:
    The query
  - abstract rx.Observable<java.lang.Boolean> delete(java.lang.Object instance)
    
    Deletes an instance
    Parameters:
    instance - The object to delete
    Returns:
    An observable that returns a boolean true if successful
  - abstract rx.Observable<java.lang.Boolean> delete(java.lang.Object instance, java.util.Map<java.lang.String, java.lang.Object> arguments)
    
    Deletes an instance
    Parameters:
    instance - The object to delete
    Returns:
    An observable that returns a boolean true if successful
  - abstract rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable instances)
    
    Deletes a number of instances
    Parameters:
    instances - The objects to delete
    Returns:
    An observable that returns the actual number of objects deleted
  - abstract rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable instances, java.util.Map<java.lang.String, java.lang.Object> arguments)
    
    Deletes a number of instances
    Parameters:
    instances - The objects to delete
    Returns:
    An observable that returns the actual number of objects deleted
  - <T1> abstract rx.Observable<T1> get(java.lang.Class<T1> type, java.io.Serializable id)
    
    Obtains a single instance for the given type and id
    Parameters:
    type - The persistent type
    id - The identifier
    Returns:
    A single observable result
  - abstract ConnectionSources<T, ConnectionSourceSettings> getConnectionSources()
    
    Returns:
    Obtain the connection sources
  - abstract RxDatastoreClient getDatastoreClient(java.lang.String connectionSourceName)
    
    Obtain another RxDatastoreClient for the given ConnectionSource name
    Parameters:
    connectionSourceName - The name of the client
    Returns:
    The RxDatastoreClient instance
  - abstract RxDatastoreClient getDatastoreClientForTenantId(java.io.Serializable tenantId)
    
    Obtains the datastore for the given tenant id. In SINGLE mode this will be a unique datastore for each tenant. For MULTI mode a single datastore is used for all tenants
    Parameters:
    tenantId - The tenant id
    Returns:
    The datastore
  - abstract ConfigurableApplicationEventPublisher getEventPublisher()
    
    Returns:
    The event publisher
  - abstract MappingContext getMappingContext()
    
    Returns:
    The mapping context
  - abstract MultiTenancyMode getMultiTenancyMode()
    
    Returns:
    The multi tenancy mode
  - abstract T getNativeInterface()
    
    Returns:
    The native interface to the datastore
  - abstract TenantResolver getTenantResolver()
    
    Returns:
    Obtain the tenant resolver
  - <T1> abstract rx.Observable<T1> insert(T1 instance, java.util.Map<java.lang.String, java.lang.Object> arguments)
    
    Force an insert of an instance and return the observable
    Parameters:
    instance - The instance
    arguments - The arguments
    Returns:
    The observable
  - abstract rx.Observable<java.util.List<java.io.Serializable>> insertAll(java.lang.Iterable objects)
    
    Batch insert all all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - abstract rx.Observable<java.util.List<java.io.Serializable>> insertAll(java.lang.Iterable objects, java.util.Map<java.lang.String, java.lang.Object> arguments)
    
    Batch insert all all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - <T1> abstract rx.Observable<T1> persist(T1 instance, java.util.Map<java.lang.String, java.lang.Object> arguments)
    
    Persist and instance and return the observable
    Parameters:
    instance - The instance
    arguments - The arguments
    Returns:
    The observable
  - <T1> abstract rx.Observable<T1> persist(T1 instance)
    
    Persist and instance and return the observable
    Parameters:
    instance - The instance
    arguments - The arguments
    Returns:
    The observable
  - abstract rx.Observable<java.util.List<java.io.Serializable>> persistAll(java.lang.Iterable objects)
    
    Batch saves all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - abstract rx.Observable<java.util.List<java.io.Serializable>> persistAll(java.lang.Iterable objects, java.util.Map<java.lang.String, java.lang.Object> arguments)
    
    Batch saves all of the given objects
    Parameters:
    objects - The objects to save
    Returns:
    An observable that emits the identifiers of the saved objects
  - <T1> abstract ObservableProxy<T1> proxy(java.lang.Class<T1> type, java.io.Serializable id)
    
    Obtain an ObservableProxy for the given type and id
    Parameters:
    type - The type
    id - The id
    Returns:
    An ObservableProxy
  - abstract ObservableProxy proxy(Query query)
    
    Obtain an ObservableProxy that executes the given query to initialize
    Parameters:
    query - The query
    Returns:
    An ObservableProxy

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Interface RxDatastoreClient<T>

Methods Summary

Inherited Methods Summary

Method Detail

abstract Query createQuery(java.lang.Class type)

abstract Query createQuery(java.lang.Class type, java.util.Map arguments)

abstract rx.Observable<java.lang.Boolean> delete(java.lang.Object instance)

abstract rx.Observable<java.lang.Boolean> delete(java.lang.Object instance, java.util.Map<java.lang.String, java.lang.Object> arguments)

abstract rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable instances)

abstract rx.Observable<java.lang.Number> deleteAll(java.lang.Iterable instances, java.util.Map<java.lang.String, java.lang.Object> arguments)

<T1> abstract rx.Observable<T1> get(java.lang.Class<T1> type, java.io.Serializable id)

abstract ConnectionSources<T, ConnectionSourceSettings> getConnectionSources()

abstract RxDatastoreClient getDatastoreClient(java.lang.String connectionSourceName)

abstract RxDatastoreClient getDatastoreClientForTenantId(java.io.Serializable tenantId)

abstract ConfigurableApplicationEventPublisher getEventPublisher()

abstract MappingContext getMappingContext()

abstract MultiTenancyMode getMultiTenancyMode()

abstract T getNativeInterface()

abstract TenantResolver getTenantResolver()

<T1> abstract rx.Observable<T1> insert(T1 instance, java.util.Map<java.lang.String, java.lang.Object> arguments)

abstract rx.Observable<java.util.List<java.io.Serializable>> insertAll(java.lang.Iterable objects)

abstract rx.Observable<java.util.List<java.io.Serializable>> insertAll(java.lang.Iterable objects, java.util.Map<java.lang.String, java.lang.Object> arguments)

<T1> abstract rx.Observable<T1> persist(T1 instance, java.util.Map<java.lang.String, java.lang.Object> arguments)

<T1> abstract rx.Observable<T1> persist(T1 instance)

abstract rx.Observable<java.util.List<java.io.Serializable>> persistAll(java.lang.Iterable objects)

abstract rx.Observable<java.util.List<java.io.Serializable>> persistAll(java.lang.Iterable objects, java.util.Map<java.lang.String, java.lang.Object> arguments)

<T1> abstract ObservableProxy<T1> proxy(java.lang.Class<T1> type, java.io.Serializable id)

abstract ObservableProxy proxy(Query query)