Deveel.Data.Sql.Sequences.QueryExtensions Class Reference

Static Public Member Functions
static ISequence	GetSequence (this IQuery context, ObjectName sequenceName)
static SqlNumber	GetNextValue (this IQuery context, ObjectName sequenceName)
	Increments the sequence and returns the computed value. More...
static SqlNumber	GetCurrentValue (this IQuery context, ObjectName sequenceName)
	Gets the current value of the sequence. More...
static void	SetCurrentValue (this IQuery context, ObjectName sequenceName, SqlNumber value)
	Sets the current value of the sequence, overriding the increment mechanism in place. More...

Detailed Description

Definition at line 23 of file QueryExtensions.cs.

Member Function Documentation

static SqlNumber Deveel.Data.Sql.Sequences.QueryExtensions.GetCurrentValue ( this IQuery  context, ObjectName  sequenceName  )

inlinestatic

Gets the current value of the sequence.

Parameters

context
sequenceName	The name of the sequence whose current value must be obtained.

Returns

Returns a SqlNumber that represents the current value of the sequence identified by the given name.

Exceptions

ObjectNotFoundException

If none sequence was found for the given sequenceName .

Definition at line 62 of file QueryExtensions.cs.

                                                                                              {
            var sequence = context.GetSequence(sequenceName);
            if (sequence == null)
                throw new InvalidOperationException(String.Format("Sequence {0} was not found.", sequenceName));

            return sequence.GetCurrentValue();
        }

static SqlNumber Deveel.Data.Sql.Sequences.QueryExtensions.GetNextValue ( this IQuery  context, ObjectName  sequenceName  )

inlinestatic

Increments the sequence and returns the computed value.

Parameters

context
sequenceName	The name of the sequence to increment and whose incremented value must be returned.

Returns

Returns a SqlNumber that represents the result of the increment operation over the sequence identified by the given name.

Exceptions

ObjectNotFoundException

If none sequence was found for the given sequenceName .

Definition at line 41 of file QueryExtensions.cs.

                                                                                           {
            var sequence = context.GetSequence(sequenceName);
            if (sequence == null)
                throw new InvalidOperationException(String.Format("Sequence {0} was not found.", sequenceName));

            return sequence.NextValue();
        }

static ISequence Deveel.Data.Sql.Sequences.QueryExtensions.GetSequence ( this IQuery  context, ObjectName  sequenceName  )

inlinestatic

Definition at line 24 of file QueryExtensions.cs.

                                                                                          {
            return context.GetObject(DbObjectType.Sequence, sequenceName, AccessType.Read) as ISequence;
        }

static void Deveel.Data.Sql.Sequences.QueryExtensions.SetCurrentValue ( this IQuery  context, ObjectName  sequenceName, SqlNumber  value  )

inlinestatic

Sets the current value of the sequence, overriding the increment mechanism in place.

Parameters

sequenceName	The name of the sequence whose current state to be set.
value	The numeric value to set.

Exceptions

ObjectNotFoundException

If none sequence was found for the given sequenceName .

Definition at line 80 of file QueryExtensions.cs.

                                                                                                          {
            var sequence = context.GetSequence(sequenceName);
            if (sequence == null)
                throw new InvalidOperationException(String.Format("Sequence {0} was not found.", sequenceName));

            sequence.SetValue(value);
        }

---

The documentation for this class was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Sql.Sequences/QueryExtensions.cs