/// <summary>
/// Specifies the consistency guarantee/constraint for index scanning.
/// </summary>
/// <param name="source">Sets scan consistency for this query. Must be a Couchbase LINQ query.</param>
/// <param name="scanConsistency">Specify the consistency guarantee/constraint for index scanning.</param>
/// <remarks>The default is <see cref="ScanConsistency.NotBounded"/>.</remarks>
public static IQueryable <T> ScanConsistency <T>(this IQueryable <T> source, ScanConsistency scanConsistency)
{
EnsureBucketQueryable(source, "ScanConsistency", "source");
((IBucketQueryExecutorProvider)source).BucketQueryExecutor.ScanConsistency = scanConsistency;
return(source);
}
/// <summary>
/// Specifies the consistency guarantee/constraint for index scanning.
/// </summary>
/// <param name="scanConsistency">Specify the consistency guarantee/constraint for index scanning.</param>
/// <returns>
/// A reference to the current <see cref="IQueryRequest" /> for method chaining.
/// </returns>
/// <exception cref="System.NotSupportedException">AtPlus and StatementPlus are not currently supported by CouchbaseServer.</exception>
/// <exception cref="NotSupportedException">AtPlus and StatementPlus are not currently supported by CouchbaseServer.</exception>
/// <remarks>
/// Optional.
/// </remarks>
public IQueryRequest ScanConsistency(ScanConsistency scanConsistency)
{
if (scanConsistency == N1QL.ScanConsistency.AtPlus ||
scanConsistency == N1QL.ScanConsistency.StatementPlus)
{
throw new NotSupportedException(
"AtPlus and StatementPlus are not currently supported by CouchbaseServer.");
}
_scanConsistency = scanConsistency;
return(this);
}
/// <summary>
/// Specifies the consistency guarantee/constraint for index scanning.
/// </summary>
/// <param name="scanConsistency">Specify the consistency guarantee/constraint for index scanning.</param>
/// <returns>
/// A reference to the current <see cref="IQueryRequest" /> for method chaining.
/// </returns>
/// <exception cref="NotSupportedException">StatementPlus are not currently supported by CouchbaseServer.</exception>
/// <remarks>
/// Optional.
/// </remarks>
public IQueryRequest ScanConsistency(ScanConsistency scanConsistency)
{
#pragma warning disable 618
if (scanConsistency == N1QL.ScanConsistency.StatementPlus)
#pragma warning restore 618
{
throw new NotSupportedException(
"AtPlus and StatementPlus are not currently supported by CouchbaseServer.");
}
_scanConsistency = scanConsistency;
return(this);
}
/// <summary>
/// The <see cref="ScanConsistency" /> you require for you <see cref="ISearchQueryResult" />s.
/// </summary>
/// <param name="consistency">The <see cref="ScanConsistency" /> for documents to be included in the query results.</param>
/// <returns></returns>
public ISearchParams WithConsistency(ScanConsistency consistency)
{
_scanConsistency = consistency;
return this;
}
/// <summary>
/// The <see cref="ScanConsistency" /> you require for you <see cref="ISearchResult" />s.
/// </summary>
/// <param name="consistency">The <see cref="ScanConsistency" /> for documents to be included in the query results.</param>
/// <returns></returns>
public ISearchOptions WithConsistency(ScanConsistency consistency)
{
_scanConsistency = consistency;
return(this);
}
public IQueryRequest ScanConsistency(ScanConsistency scanConsistency)
{
_scanConsistency = scanConsistency;
return(this);
}
/// <summary>
/// The <see cref="ScanConsistency" /> you require for you <see cref="ISearchQueryResult" />s.
/// </summary>
/// <param name="consistency">The <see cref="ScanConsistency" /> for documents to be included in the query results.</param>
/// <returns></returns>
public SearchQuery WithConsistency(ScanConsistency consistency)
{
SearchParams.WithConsistency(consistency);
return(this);
}
/// <summary>
/// Specifies the consistency guarantee/constraint for index scanning.
/// </summary>
/// <param name="scanConsistency">Specify the consistency guarantee/constraint for index scanning.</param>
/// <returns>
/// A reference to the current <see cref="IQueryRequest" /> for method chaining.
/// </returns>
/// <exception cref="System.NotSupportedException">AtPlus and StatementPlus are not currently supported by CouchbaseServer.</exception>
/// <exception cref="NotSupportedException">AtPlus and StatementPlus are not currently supported by CouchbaseServer.</exception>
/// <remarks>
/// Optional.
/// </remarks>
public IQueryRequest ScanConsistency(ScanConsistency scanConsistency)
{
if (scanConsistency == N1QL.ScanConsistency.AtPlus ||
scanConsistency == N1QL.ScanConsistency.StatementPlus)
{
throw new NotSupportedException(
"AtPlus and StatementPlus are not currently supported by CouchbaseServer.");
}
_scanConsistency = scanConsistency;
return this;
}
/// <summary>
/// Resolves the specified <see cref="ScanConsistency"/> to a Couchbase Server <see cref="string"/> equivalent.
/// </summary>
/// <param name="scanConsistency">The scam consistency.</param>
/// <returns></returns>
public static string Resolve(ScanConsistency scanConsistency)
{
return(ScanConsistencyResolver[scanConsistency]);
}
/// <summary>
/// Resolves the specified <see cref="ScanConsistency"/> to a Couchbase Server <see cref="string"/> equivalent.
/// </summary>
/// <param name="scanConsistency">The scam consistency.</param>
/// <returns></returns>
public static string Resolve(ScanConsistency scanConsistency)
{
return ScanConsistencyResolver[scanConsistency];
}
/// <summary>
/// Specifies the consistency guarantee/constraint for index scanning.
/// </summary>
/// <param name="scanConsistency">Specify the consistency guarantee/constraint for index scanning.</param>
/// <returns>
/// A reference to the current <see cref="IQueryRequest" /> for method chaining.
/// </returns>
/// <exception cref="NotSupportedException">StatementPlus are not currently supported by CouchbaseServer.</exception>
/// <remarks>
/// Optional.
/// </remarks>
public IQueryRequest ScanConsistency(ScanConsistency scanConsistency)
{
#pragma warning disable 618
if (scanConsistency == N1QL.ScanConsistency.StatementPlus)
#pragma warning restore 618
{
throw new NotSupportedException(
"AtPlus and StatementPlus are not currently supported by CouchbaseServer.");
}
_scanConsistency = scanConsistency;
return this;
}
/// <summary>
/// The <see cref="ScanConsistency" /> you require for you <see cref="ISearchQueryResult" />s.
/// </summary>
/// <param name="consistency">The <see cref="ScanConsistency" /> for documents to be included in the query results.</param>
/// <returns></returns>
public SearchQuery WithConsistency(ScanConsistency consistency)
{
SearchParams.WithConsistency(consistency);
return this;
}
public IQueryRequest ScanConsistency(ScanConsistency scanConsistency)
{
_scanConsistency = scanConsistency;
return this;
}