• SnapObjects .NET API Documentation

    This site offers links to all the available documents related to SnapObjects .NET development. If you want to find the documents of the other Appeon products (PowerBuilder IDE, SnapDevelop, DataWindow Converter, PowerScript Migrator, PowerServer, and InfoMaker), go to the Appeon Documentation Center.

    SnapObjects .NET API

    Getting Started:

    Features List of SnapObjects 5.x

    Installation Guide of SnapObjects 5.x

    Release Bulletin of SnapObjects 5.x

    API Reference:

    SnapObjects .NET API Reference (5.x) (4.x) (3.1.x) (3.0.0) (2.1.0) (2.0.0) (1.0.x)

    Tutorials:

    CRUD Operations with SqlModelMapper

    Add Data Validation to SqlModelMapper

    Developer Guides:

    Working with Transactions in SnapObjects

    Using Nested Models in SqlModelMapper

    Tracking Actions with SqlModelMapper

    Type-Safe Queries Using SnapObjects API

  • SnapObjects.Data.SqlServer
  • SqlServerDataContextOptions
  • Constructors
  • SqlServerDataContextOptions

    Show / Hide Table of Contents
    • Readme First!
    • SnapObjects.Data (3.1.x)
      • Attributes for Model Class and Property
        • Class
          • DistinctAttribute
            • Constructors
              • DistinctAttribute
          • FromTableAttribute
            • Constructors
              • FromTableAttribute
                • FromTableAttribute(String)
                • FromTableAttribute(String, String)
            • Properties
              • Alias
              • AliasDefined
              • Name
              • Schema
              • WhereRaw
          • JoinTableAttribute
            • Constructors
              • JoinTableAttribute
                • JoinTableAttribute(String)
                • JoinTableAttribute(String, String)
            • Properties
              • Alias
              • AliasDefined
              • JoinType
              • Name
              • OnRaw
              • Schema
          • SqlAndHavingAttribute
            • Constructors
              • SqlAndHavingAttribute
                • SqlAndHavingAttribute(String)
                • SqlAndHavingAttribute(String, String)
            • Properties
              • Left
              • Operator
              • RawCondition
              • RawConditionDefined
              • Right
          • SqlAndWhereAttribute
            • Constructors
              • SqlAndWhereAttribute
                • SqlAndWhereAttribute(String)
                • SqlAndWhereAttribute(String, String)
            • Properties
              • Left
              • Operator
              • RawCondition
              • RawConditionDefined
              • Right
          • SqlGroupByAttribute
            • Constructors
              • SqlGroupByAttribute
            • Properties
              • GroupByExpressions
          • SqlHavingAttribute
            • Constructors
              • SqlHavingAttribute
                • SqlHavingAttribute(String)
                • SqlHavingAttribute(String, String)
            • Properties
              • Left
              • Operator
              • RawCondition
              • RawConditionDefined
              • Right
          • SqlOrderByAttribute
            • Constructors
              • SqlOrderByAttribute
            • Properties
              • OrderByExpressions
          • SqlOrHavingAttribute
            • Constructors
              • SqlOrHavingAttribute
                • SqlOrHavingAttribute(String)
                • SqlOrHavingAttribute(String, String)
            • Properties
              • Left
              • Operator
              • RawCondition
              • RawConditionDefined
              • Right
          • SqlOrWhereAttribute
            • Constructors
              • SqlOrWhereAttribute
                • SqlOrWhereAttribute(String)
                • SqlOrWhereAttribute(String, String)
            • Properties
              • Left
              • Operator
              • RawCondition
              • RawConditionDefined
              • Right
          • SqlParameterAttribute
            • Constructors
              • SqlParameterAttribute
            • Properties
              • DataType
              • Direction
              • Name
          • SqlSelectAttribute
            • Constructors
              • SqlSelectAttribute
            • Properties
              • RawSelect
              • SelectName
          • SqlUnionAttribute
            • Constructors
              • SqlUnionAttribute
                • SqlUnionAttribute(String)
                • SqlUnionAttribute(Type)
                • SqlUnionAttribute(Type, String)
            • Properties
              • IsRawSql
              • ModelType
              • RawSql
              • SelectName
              • UnionAll
          • SqlWhereAttribute
            • Constructors
              • SqlWhereAttribute
                • SqlWhereAttribute(String)
                • SqlWhereAttribute(String, String)
            • Properties
              • Left
              • Operator
              • RawCondition
              • RawConditionDefined
              • Right
          • SubQueryAttribute
            • Constructors
              • SubQueryAttribute
                • SubQueryAttribute(String, String)
                • SubQueryAttribute(String, Type)
                • SubQueryAttribute(String, Type, String)
            • Properties
              • IsRawSql
              • ModelType
              • Name
              • RawSql
              • SelectName
          • TopAttribute
            • Constructors
              • TopAttribute
            • Properties
              • TopRows
          • UpdateWhereStrategyAttribute
            • Constructors
              • UpdateWhereStrategyAttribute
            • Properties
              • UpdateWhereStrategy
        • Properties
          • DefaultValueAttribute
          • IdentityAttribute
          • ModelEmbeddedAttribute
            • Constructors
              • ModelEmbeddedAttribute
            • Properties
              • CascadeCreate
              • CascadeDelete
              • ModelType
              • ParamValue
              • QueryExpression
              • QuerySelector
          • PropertySaveAttribute
            • Constructors
              • PropertySaveAttribute
            • Properties
              • SaveStrategy
          • SetValueAttribute
            • Constructors
              • SetValueAttribute
                • SetValueAttribute(String, String)
                • SetValueAttribute(String, String, SetValueStrategy)
                • SetValueAttribute(String, String, SetValueStrategy, ModelSelector)
            • Properties
              • ModelSelector
              • SetValueStrategy
              • Source
              • Target
          • SqlColumnAttribute
            • Constructors
              • SqlColumnAttribute
                • SqlColumnAttribute(String)
                • SqlColumnAttribute(String, String)
                • SqlColumnAttribute(String, String, String)
            • Properties
              • Column
              • ColumnAlias
              • ColumnAliasDefined
              • Order
              • TableAlias
              • TableAliasDefined
              • TypeName
          • SqlComputeAttribute
            • Constructors
              • SqlComputeAttribute
                • SqlComputeAttribute(String)
                • SqlComputeAttribute(String, String)
            • Properties
              • Alias
              • AliasDefined
              • Expression
              • Order
              • TypeName
          • SqlDefaultValueAttribute
            • Constructors
              • SqlDefaultValueAttribute
            • Properties
              • DefaultValue
          • SqlEmbeddedAttribute
            • Constructors
              • SqlEmbeddedAttribute
            • Properties
              • ParamValue
              • RawSql
      • SqlModelMapper
        • IDetailTracker
          • Properties
            • MasterModel
          • Methods
            • SaveChanges
            • TrackDetail
            • TrackDetails
            • TrackGrandDetail
            • TrackGrandDetails
        • IEmbeddedLoadable
          • Properties
            • MasterModel
          • Methods
            • Include
            • IncludeAll
            • IncludeAllAsync
            • IncludeAsync
        • ILoadable
          • Methods
            • FirstOrDefault
            • Include
              • Include(Expression<Func<TModel, object>>, Boolean)
              • Include(Int, Expression<Func<TModel, object>>, Boolean)
            • IncludeAll
              • IncludeAll(Boolean)
              • IncludeAll(Int, Boolean)
            • IncludeAllAsync
              • IncludeAllAsync(bool, CancellationToken)
              • IncludeAllAsync(int, bool, CancellationToken)
            • IncludeAsync
              • IncludeAsync(Expression<Func<TModel, object>>, bool, CancellationToken)
              • IncludeAsync(int, Expression<Func<TModel, object>>, bool, CancellationToken)
            • ToArray
            • ToDictionary
            • ToList
        • IQueryAndOrBuilder
          • Methods
            • AndWhere
              • AndWhere(string, ISqlParameter)
              • AndWhere(string, SqlBinaryOperator, ISqlParameter)
              • AndWhere(string, string)
              • AndWhere(string, SqlBinaryOperator, string)
              • AndWhere(string, ISqlBuilder)
              • AndWhere(string, SqlBinaryOperator, ISqlBuilder)
              • AndWhere(ISqlWhereCondition)
            • AndWhereExists
            • AndWhereIsNotNull
            • AndWhereIsNull
            • AndWhereNotExists
            • AndWhereRaw
            • AndWhereValue
              • AndWhereValue(string, object)
              • AndWhereValue(string, SqlBinaryOperator, object)
            • OrWhere
              • OrWhere(string, ISqlParameter)
              • OrWhere(string, SqlBinaryOperator, ISqlParameter)
              • OrWhere(string, string)
              • OrWhere(string, SqlBinaryOperator, string)
              • OrWhere(string, ISqlBuilder)
              • OrWhere(string, SqlBinaryOperator, ISqlBuilder)
              • OrWhere(ISqlWhereCondition)
            • OrWhereExists
            • OrWhereIsNotNull
            • OrWhereIsNull
            • OrWhereNotExists
            • OrWhereRaw
            • OrWhereValue
              • OrWhereValue(string, object)
              • OrWhereValue(string, SqlBinaryOperator, object)
        • IQueryBuilder
          • Methods
            • RemoveWhere (Obsolete)
        • IQueryWhereBuilder
          • Methods
            • Where
              • Where(string, string)
              • Where(string, SqlBinaryOperator, string)
              • Where(string, ISqlParameter)
              • Where(string, SqlBinaryOperator, ISqlParameter)
              • Where(string, ISqlBuilder)
              • Where(string, SqlBinaryOperator, ISqlBuilder)
              • Where(ISqlWhereCondition)
            • WhereExists
            • WhereIsNotNull
            • WhereIsNull
            • WhereNotExists
            • WhereRaw
            • WhereValue
              • WhereValue(string, object)
              • WhereValue(string, SqlBinaryOperator, object)
        • ISqlBuilderLoader
          • Methods
            • Load
            • LoadAsync
              • LoadAsync(params object[])
              • LoadAsync(object[], CancellationToken)
            • LoadByPage
            • LoadByPageAsync
              • LoadByPageAsync(int, int, params object[])
              • LoadByPageAsync(int, int, object[], CancellationToken)
        • ISqlModelMapper
          • Methods
            • Avg
            • ClearTracked
            • Count
            • DistinctCount
            • Exists
            • GetQueryBuilder
            • KeyExists
            • Load
            • LoadAsync
              • LoadAsync<T>(params object[])
              • LoadAsync<T>(object[], CancellationToken)
            • LoadAll
            • LoadAllAsync
              • LoadAllAsync<T>()
              • LoadAllAsync<T>(CancellationToken)
            • LoadAllByPage
            • LoadAllByPageAsync
              • LoadAllByPageAsync<T>(int, int)
              • LoadAllByPageAsync<T>(int, int, CancellationToken)
            • LoadByKey
            • LoadByKeyAsync
              • LoadByKeyAsync<T>(params object[])
              • LoadByKeyAsync<T>(object[], CancellationToken)
            • LoadByPage
            • LoadByPageAsync
              • LoadByPageAsync<TModel>(int, int, params object[])
              • LoadByPageAsync<TModel>(int, int, object[], CancellationToken)
            • LoadEmbedded
            • Max
            • Min
            • RemoveTrackedModel
            • SaveChanges
            • SaveChangesAsync
              • SaveChangesAsync()
              • SaveChangesAsync(CancellationToken)
            • Scalar
            • ScalarAsync
              • ScalarAsync<T, T>(string, params object[])
              • ScalarAsync<T, T>(string, object[], CancellationToken)
            • ScalarByKey
            • ScalarByKeyAsync
              • ScalarByKeyAsync<T, T>(string, params object[])
              • ScalarByKeyAsync<T, T>(string, object[], CancellationToken)
            • Sum
            • Track
              • Track(Action<ISaveContext>)
              • Track<T>(IModelEntry<T>)
              • Track<T>(IModelEntry<T>, Action<ISaveContext>)
              • Track(IMapperTrackable, params object[])
            • TrackCreate
              • TrackCreate<T>(TModel)
              • TrackCreate<T>(TModel, Action<ISaveContext>)
            • TrackCreateRange
            • TrackDelete
              • TrackDelete<T>(TModel)
              • TrackDelete<T>(TModel, Action<ISaveContext>)
            • TrackDeleteByKey
            • TrackDeleteRange
            • TrackMaster
              • TrackMaster<T>(IModelEntry<T>)
              • TrackMaster<T>(IModelEntry<T>, Action<ISaveContext>)
            • TrackRange
            • TrackSqlBuilder
              • TrackSqlBuilder(ISqlInsertBuilder, Object[])
              • TrackSqlBuilder(ISqlDeleteBuilder, Object[])
              • TrackSqlBuilder(ISqlUpdateBuilder, Object[])
            • TrackSqlCUD
            • TrackUpdate
              • TrackUpdate<T>(TModel)
              • TrackUpdate<T>(TModel, Action<ISaveContext>)
              • TrackUpdate<T>(TModel, TModel)
              • TrackUpdate<T>(TModel, TModel, Action<ISaveContext>)
            • TrackUpdateRange
            • ValidateTrackedModels
              • ValidateTrackedModels()
              • ValidateTrackedModels(List<ValidationResult>)
        • SqlModelMapper
          • Constructors
            • SqlModelMapper
      • SqlBuilder
        • ISqlBuilder
          • Methods
            • AddParameters
            • Clone
            • GetParameterPlacehold
            • Reset
            • ToReadOnly
        • ISqlBuilderBase
          • Properties
            • Name
            • SqlType
            • UsedParameters
          • Methods
            • ToSqlString
            • Validate
            • ValidateAsync
              • ValidateAsync(DataContext, bool)
              • ValidateAsync(DataContext, bool, CancellationToken)
        • ISqlBuilderCache
          • Methods
            • Get
            • GetModifiable
            • Set
        • ISqlConditionBuilder
          • Properties
            • UsedParameters
          • Methods
            • ToSqlString
        • ISqlDeleteBuilder
          • Methods
            • Delete
              • Delete(String)
              • Delete(String, String)
        • ISqlFromBuilder
          • Properties
            • HasTable
          • Methods
            • AsJoin
            • From
              • From(ISqlBuilder, String)
              • From(String)
              • From(String, String)
              • From(String, String, String)
            • FromRaw
              • FromRaw(String)
              • FromRaw(String, String)
            • GetTableAlias
        • ISqlGroupBuilder
          • Methods
            • AsHaving
            • GroupBy
              • GroupBy(String[])
              • GroupBy(String)
        • ISqlHavingAndOr
        • ISqlHavingAndOr<T>
          • Methods
            • AndHaving
              • AndHaving(String, ISqlParameter)
              • AndHaving(String, SqlBinaryOperator, ISqlParameter)
              • AndHaving(String, String)
              • AndHaving(String, SqlBinaryOperator, String)
              • AndHaving(String, ISqlBuilder)
              • AndHaving(String, SqlBinaryOperator, ISqlBuilder)
              • AndHaving(ISqlHavingCondition)
              • AndHaving(ISqlHavingCondition, String)
            • AndHavingRaw
              • AndHavingRaw(String, ISqlParameter[])
              • AndHavingRaw(String, String, ISqlParameter[])
            • AndHavingValue
              • AndHavingValue(String, Object)
              • AndHavingValue(String, SqlBinaryOperator, Object)
            • OrHaving
              • OrHaving(String, ISqlParameter)
              • OrHaving(String, SqlBinaryOperator, ISqlParameter)
              • OrHaving(String, String)
              • OrHaving(String, SqlBinaryOperator, String)
              • OrHaving(String, ISqlBuilder)
              • OrHaving(String, SqlBinaryOperator, ISqlBuilder)
              • OrHaving(ISqlHavingCondition)
              • OrHaving(ISqlHavingCondition, String)
            • OrHavingRaw
              • OrHavingRaw(String, ISqlParameter[])
              • OrHavingRaw(String, String, ISqlParameter[])
            • OrHavingValue
              • OrHavingValue(String, Object)
              • OrHavingValue(String, SqlBinaryOperator, Object)
        • ISqlHavingBuilder
          • Methods
            • AsOrderBy
            • Having
              • Having(String, ISqlParameter)
              • Having(String, SqlBinaryOperator, ISqlParameter)
              • Having(String, String)
              • Having(String, SqlBinaryOperator, String)
              • Having(String, ISqlBuilder)
              • Having(String, SqlBinaryOperator, ISqlBuilder)
              • Having(ISqlHavingCondition)
              • Having(ISqlHavingCondition, String)
            • HavingRaw
              • HavingRaw(String, ISqlParameter[])
              • HavingRaw(String, String, ISqlParameter[])
            • HavingValue
              • HavingValue(String, Object)
              • HavingValue(String, SqlBinaryOperator, Object)
        • ISqlHavingCondition
        • ISqlInsertBuilder
          • Methods
            • Column
            • ColumnValue
            • Insert
              • Insert(String)
              • Insert(String, String)
        • ISqlJoinBuilder
          • Properties
            • HasJoin
            • HasOn
          • Methods
            • AsWhere
            • FullJoin
              • FullJoin(String)
              • FullJoin(String, String)
              • FullJoin(String, String, String)
              • FullJoin(ISqlBuilder, String)
            • FullJoinRaw
              • FullJoinRaw(String)
              • FullJoinRaw(String, String)
            • GetJoinType
            • InnerJoin
              • InnerJoin(String)
              • InnerJoin(String, String)
              • InnerJoin(String, String, String)
              • InnerJoin(ISqlBuilder, String)
            • InnerJoinRaw
              • InnerJoinRaw(String)
              • InnerJoinRaw(String, String)
            • Join
              • Join(String)
              • Join(String, String)
              • Join(String, String, String)
              • Join(ISqlBuilder, String)
            • JoinRaw
              • JoinRaw(String)
              • JoinRaw(String, String)
            • LeftJoin
              • LeftJoin(String)
              • LeftJoin(String, String)
              • LeftJoin(String, String, String)
              • LeftJoin(ISqlBuilder, String)
            • LeftJoinRaw
              • LeftJoinRaw(String)
              • LeftJoinRaw(String, String)
            • RightJoin
              • RightJoin(String)
              • RightJoin(String, String)
              • RightJoin(String, String, String)
              • RightJoin(ISqlBuilder, String)
            • RightJoinRaw
              • RightJoinRaw(String)
              • RightJoinRaw(String, String)
        • ISqlJoinCondition
        • ISqlJoinOnAndOr
        • ISqlJoinOnAndOr<T>
          • Properties
            • HasOn
          • Methods
            • AndOn
              • AndOn(String, String)
              • AndOn(String, SqlBinaryOperator, String)
              • AndOn(String, ISqlParameter)
              • AndOn(String, SqlBinaryOperator, ISqlParameter)
              • AndOn(String, ISqlBuilder)
              • AndOn(String, SqlBinaryOperator, ISqlBuilder)
              • AndOn(ISqlJoinCondition)
            • AndOnRaw
            • AndOnValue
              • AndOnValue(String, Object)
              • AndOnValue(String, SqlBinaryOperator, Object)
            • OrOn
              • OrOn(String, String)
              • OrOn(String, SqlBinaryOperator, String)
              • OrOn(String, ISqlParameter)
              • OrOn(String, SqlBinaryOperator, ISqlParameter)
              • OrOn(String, ISqlBuilder)
              • OrOn(String, SqlBinaryOperator, ISqlBuilder)
              • OrOn(ISqlJoinCondition)
            • OrOnRaw
            • OrOnValue
              • OrOnValue(String, Object)
              • OrOnValue(String, SqlBinaryOperator, Object)
        • ISqlJoinOnBuilder
          • Methods
            • On
              • On(String, String)
              • On(String, SqlBinaryOperator, String)
              • On(String, ISqlParameter)
              • On(String, SqlBinaryOperator, ISqlParameter)
              • On(String, ISqlBuilder)
              • On(String, SqlBinaryOperator, ISqlBuilder)
              • On(ISqlJoinCondition)
            • OnRaw
            • OnValue
              • OnValue(String, Object)
              • OnValue(String, SqlBinaryOperator, Object)
        • ISqlOrderBuilder
          • Methods
            • OrderByAscending
            • OrderByDescending
            • OrderByRaw
              • OrderByRaw(String)
              • OrderByRaw(String, String)
        • ISqlOrderThenBuilder
          • Methods
            • ThenByAscending
            • ThenByDescending
            • ThenByRaw
              • ThenByRaw(String)
              • ThenByRaw(String, String)
        • ISqlQueryBuilder
          • Methods
            • Distinct
            • Page
            • RemoveSelect
            • ReplaceSelect
            • Select
              • Select(ISqlBuilder)
              • Select(ISqlBuilder, String)
              • Select(String)
              • Select(String[])
              • Select(String, String)
            • SelectRaw
              • SelectRaw(String, ISqlParameter[])
              • SelectRaw(String, String, ISqlParameter[])
            • Top
            • Union
              • Union(ISqlQueryBuilder)
              • Union(ISqlQueryBuilder, String)
              • Union(String)
              • Union(String, String)
            • UnionAll
              • UnionAll(ISqlQueryBuilder)
              • UnionAll(ISqlQueryBuilder, String)
              • UnionAll(String)
              • UnionAll(String, String)
        • ISqlRawBuilder
          • Methods
            • Raw
        • ISqlReadOnlyBuilder
        • ISqlUpdateBuilder
          • Methods
            • Set
              • Set(String, ISqlParameter)
              • Set(String, String)
              • Set(String, ISqlBuilder)
            • SetRaw
            • SetValue
            • Update
              • Update(String)
              • Update(String, String)
        • ISqlWhereAndOr
        • ISqlWhereAndOr<T>
          • Methods
            • AndWhere
              • AndWhere(String, ISqlParameter)
              • AndWhere(String, SqlBinaryOperator, ISqlParameter)
              • AndWhere(String, String)
              • AndWhere(String, SqlBinaryOperator, String)
              • AndWhere(String, ISqlBuilder)
              • AndWhere(String, SqlBinaryOperator, ISqlBuilder)
              • AndWhere(ISqlWhereCondition)
            • AndWhereExists
            • AndWhereIsNotNull
            • AndWhereIsNull
            • AndWhereNotExists
            • AndWhereRaw
            • AndWhereValue
              • AndWhereValue(String, Object)
              • AndWhereValue(String, SqlBinaryOperator, Object)
            • OrWhere
              • OrWhere(String, ISqlParameter)
              • OrWhere(String, SqlBinaryOperator, ISqlParameter)
              • OrWhere(String, String)
              • OrWhere(String, SqlBinaryOperator, String)
              • OrWhere(String, ISqlBuilder)
              • OrWhere(String, SqlBinaryOperator, ISqlBuilder)
              • OrWhere(ISqlWhereCondition)
            • OrWhereExists
            • OrWhereIsNotNull
            • OrWhereIsNull
            • OrWhereNotExists
            • OrWhereRaw
            • OrWhereValue
              • OrWhereValue(String, Object)
              • OrWhereValue(String, SqlBinaryOperator, Object)
        • ISqlWhereBuilder
          • Properties
            • HasWhere
          • Methods
            • AsGroupBy
            • RemoveWhere
              • RemoveWhere()
              • RemoveWhere(String)
            • Where
              • Where(String, String)
              • Where(String, SqlBinaryOperator, String)
              • Where(String, ISqlParameter)
              • Where(String, SqlBinaryOperator, ISqlParameter)
              • Where(String, ISqlBuilder)
              • Where(String, SqlBinaryOperator, ISqlBuilder)
              • Where(ISqlWhereCondition)
              • Where(ISqlWhereCondition, String)
            • WhereExists
            • WhereIsNotNull
            • WhereIsNull
            • WhereNotExists
            • WhereRaw
              • WhereRaw(String, ISqlParameter[])
              • WhereRaw(String, String, ISqlParameter[])
            • WhereValue
              • WhereValue(String, Object)
              • WhereValue(String, SqlBinaryOperator, Object)
        • ISqlWhereCondition
        • SqlBuilder
          • Methods
            • Delete
              • Delete(String)
              • Delete(String, String)
            • EmbeddedHaving
              • EmbeddedHaving(String, String)
              • EmbeddedHaving(String, SqlBinaryOperator, String)
              • EmbeddedHaving(String, ISqlParameter)
              • EmbeddedHaving(String, SqlBinaryOperator, ISqlParameter)
              • EmbeddedHaving(String, ISqlBuilder)
              • EmbeddedHaving(String, SqlBinaryOperator, ISqlBuilder)
            • EmbeddedHavingRaw
              • EmbeddedHavingRaw(String, ISqlParameter[])
              • EmbeddedHavingRaw(String, String, ISqlParameter[])
            • EmbeddedHavingValue
              • EmbeddedHavingValue(String, Object)
              • EmbeddedHavingValue(String, SqlBinaryOperator, Object)
            • EmbeddedOn
              • EmbeddedOn(String, String)
              • EmbeddedOn(String, SqlBinaryOperator, String)
              • EmbeddedOn(String, ISqlParameter)
              • EmbeddedOn(String, SqlBinaryOperator, ISqlParameter)
              • EmbeddedOn(String, ISqlBuilder)
              • EmbeddedOn(String, SqlBinaryOperator, ISqlBuilder)
            • EmbeddedOnRaw
              • EmbeddedOnRaw(String, ISqlParameter[])
              • EmbeddedOnRaw(String, String, ISqlParameter[])
            • EmbeddedOnValue
              • EmbeddedOnValue(String, Object)
              • EmbeddedOnValue(String, SqlBinaryOperator, Object)
            • EmbeddedWhere
              • EmbeddedWhere(String, String)
              • EmbeddedWhere(String, SqlBinaryOperator, String)
              • EmbeddedWhere(String, ISqlParameter)
              • EmbeddedWhere(String, SqlBinaryOperator, ISqlParameter)
              • EmbeddedWhere(String, ISqlBuilder)
              • EmbeddedWhere(String, SqlBinaryOperator, ISqlBuilder)
            • EmbeddedWhereExists
            • EmbeddedWhereIsNotNull
            • EmbeddedWhereIsNull
            • EmbeddedWhereNotExists
            • EmbeddedWhereRaw
              • EmbeddedWhereRaw(String, ISqlParameter[])
              • EmbeddedWhereRaw(String, String, ISqlParameter[])
            • EmbeddedWhereValue
              • EmbeddedWhereValue(String, Object)
              • EmbeddedWhereValue(String, SqlBinaryOperator, Object)
            • Having
              • Having(String, String)
              • Having(String, SqlBinaryOperator, String)
              • Having(String, ISqlParameter)
              • Having(String, SqlBinaryOperator, ISqlParameter)
              • Having(String, ISqlBuilder)
              • Having(String, SqlBinaryOperator, ISqlBuilder)
            • HavingRaw
              • HavingRaw(String, ISqlParameter[])
              • HavingRaw(String, String, ISqlParameter[])
            • HavingValue
              • HavingValue(String, Object)
              • HavingValue(String, SqlBinaryOperator, Object)
            • Insert
              • Insert(String)
              • Insert(String, String)
            • On
              • On(String, String)
              • On(String, SqlBinaryOperator, String)
              • On(String, ISqlParameter)
              • On(String, SqlBinaryOperator, ISqlParameter)
              • On(String, ISqlBuilder)
              • On(String, SqlBinaryOperator, ISqlBuilder)
            • OnRaw
              • OnRaw(String, ISqlParameter[])
              • OnRaw(String, String, ISqlParameter[])
            • OnValue
              • OnValue(String, Object)
              • OnValue(String, SqlBinaryOperator, Object)
            • Parameter
              • Parameter<T>(String)
              • Parameter(Type, String)
            • Select
              • Select(String, String)
              • Select(String[])
              • Select(ISqlBuilder, String)
            • SelectRaw
            • Update
              • Update(String)
              • Update(String, String)
            • Where
              • Where(String, String)
              • Where(String, SqlBinaryOperator, String)
              • Where(String, ISqlParameter)
              • Where(String, SqlBinaryOperator, ISqlParameter)
              • Where(String, ISqlBuilder)
              • Where(String, SqlBinaryOperator, ISqlBuilder)
            • WhereExists
            • WhereIsNotNull
            • WhereIsNull
            • WhereNotExists
            • WhereRaw
              • WhereRaw(String, ISqlParameter[])
              • WhereRaw(String, String, ISqlParameter[])
            • WhereValue
              • WhereValue(String, Object)
              • WhereValue(String, SqlBinaryOperator, Object)
        • SqlBuilderBase
          • Constructors
            • SqlBuilderBase
        • SqlBuilderFactory
          • Properties
            • Cache
          • Methods
            • Create
        • SqlDeleteBuilder
          • Constructors
            • SqlDeleteBuilder
        • SqlInsertBuilder
          • Constructors
            • SqlInsertBuilder
        • SqlQueryBuilder
          • Constructors
            • SqlQueryBuilder
        • SqlRawBuilder
          • Constructors
            • SqlRawBuilder
        • SqlStatementType
        • SqlUpdateBuilder
          • Constructors
            • SqlUpdateBuilder
      • SqlExecutor
        • ILazyQueryable<T>
        • SqlExecutor
          • Constructors
            • SqlExecutor
        • ISqlExecutor
          • Properties
            • DataContext
          • Methods
            • Execute
            • ExecuteAsync
              • ExecuteAsync(string, params object[])
              • ExecuteAsync(string, params object[], CancellationToken)
            • ExecuteProcedure
            • ExecuteProcedureAsync
              • ExecuteProcedureAsync(string, params object[])
              • ExecuteProcedureAsync(string, object[], CancellationToken)
            • Scalar
              • Scalar<T>(String, Object[])
              • Scalar<T>(ISqlQueryBuilder, Object[])
            • ScalarAsync
              • ScalarAsync<T>(string, params object[])
              • ScalarAsync<T>(string, object[], CancellationToken)
              • ScalarAsync<T>(ISqlQueryBuilder, params object[])
              • ScalarAsync<T>(ISqlQueryBuilder, object[], CancellationToken)
            • Select
              • Select<T>(String, Object[])
              • Select<T>(ISqlQueryBuilder, Object[])
            • SelectAsync
              • SelectAsync<T>(string, params object[])
              • SelectAsync<T>(string, object[], CancellationToken)
              • SelectAsync<T>(ISqlQueryBuilder, params object[])
              • SelectAsync<T>(ISqlQueryBuilder, CancellationToken)
            • SelectLazy
              • SelectLazy<T>(String, Object[])
              • SelectLazy<T>(ISqlQueryBuilder, Object[])
            • SelectLazyAsync
              • SelectLazyAsync<T>(ISqlQueryBuilder, params object[])
              • SelectLazyAsync<T>(ISqlQueryBuilder, object[], CancellationToken)
              • SelectLazyAsync<T>(string, params object[])
              • SelectLazyAsync<T>(string, object[], CancellationToken)
            • SelectOne
              • SelectOne<T>(String, Object[])
              • SelectOne<T>(ISqlQueryBuilder, Object[])
            • SelectOneAsync
              • SelectOneAsync<T>(string, params object[])
              • SelectOneAsync<T>(string, object[], CancellationToken)
              • SelectOneAsync<T>(ISqlQueryBuilder, params object[])
              • SelectOneAsync<T>(ISqlQueryBuilder, object[], CancellationToken)
            • SelectProcedure
            • SelectProcedureAsync
              • SelectProcedureAsync<T>(string, params object[])
              • SelectProcedureAsync<T>(string, object[], CancellationToken)
      • ChangeTrackingStrategy
      • DatabaseType
      • DataContext
        • Constructors
          • DataContext
            • DataContext(IDataContextOptions)
            • DataContext(DbConnection, IDataContextOptions)
        • Properties
          • ContextOptions
          • CurrentConnection
          • CurrentTransaction
          • SqlModelMapper
          • SqlExecutor
        • Methods
          • BeginTransaction
            • BeginTransaction()
            • BeginTransaction(IsolationLevel)
          • BeginTransactionAsync
            • BeginTransactionAsync()
            • BeginTransactionAsync(CancellationToken)
            • BeginTransactionAsync(IsolationLevel)
            • BeginTransactionAsync(IsolationLevel, CancellationToken)
          • Commit
          • Dispose
          • Rollback
          • UseTransaction
      • DataFormat
      • DataPacker
        • Constructors
          • DataPacker
      • DataTableExtensions
        • Methods
          • ExportJson
            • ExportJson(DataTable)
            • ExportJson(DataTable, Bool)
            • ExportJson(DataTable, Int)
            • ExportJson(DataTable, Int, Int)
            • ExportJson(DataTable, Int, Int, Short)
            • ExportJson(DataTable, Int, Int, Short, Short)
          • ExportXml
            • ExportXml(DataTable)
            • ExportXml(DataTable, Bool)
            • ExportXml(DataTable, Int)
            • ExportXml(DataTable, Int, Int)
            • ExportXml(DataTable, Int, Int, Short)
            • ExportXml(DataTable, Int, Int, Short, Short)
          • ImportJson
            • ImportJson(DataTable, String)
            • ImportJson(DataTable, String, Int)
            • ImportJson(DataTable, String, Int, Int)
            • ImportJson(DataTable, String, Int, Int, Short)
            • ImportJson(DataTable, String, Int, Int, Short, Short)
          • ImportJsonByKey
            • ImportJsonByKey(DataTable, String)
            • ImportJsonByKey(DataTable, String, Int)
            • ImportJsonByKey(DataTable, String, Int, Int)
          • ImportXml
            • ImportXml(DataTable, String)
            • ImportXml(DataTable, String, Int)
            • ImportXml(DataTable, String, Int, Int)
            • ImportXml(DataTable, String, Int, Int, Short)
            • ImportXml(DataTable, String, Int, Int, Short, Short)
          • ImportXmlByKey
            • ImportXmlByKey(DataTable, String)
            • ImportXmlByKey(DataTable, String, Int)
            • ImportXmlByKey(DataTable, String, Int, Int)
      • DataUnPacker
        • Constructors
          • DataUnPacker
      • DynamicModel
        • Properties
          • Item
            • Item[Int32]
            • Item[String]
          • Properties
          • PropertiesCount
        • Methods
          • Clone
          • CopyFrom
            • CopyFrom(DynamicModel)
            • CopyFrom(DynamicModel, Int, Int)
          • GetValue
            • GetValue(Int)
            • GetValue<T>(Int)
            • GetValue(String)
            • GetValue<T>(String)
          • IndexOf
          • SetValue
            • SetValue(Int, Object)
            • SetValue(String, Object)
          • SetValues
      • IAdoDbConnection
        • Properties
          • ConnectionId
          • ConnectionString
          • CurrentTransaction
          • DbConnection
        • Methods
          • Close
          • CloseAsync
            • CloseAsync
            • CloseAsync(CancellationToken)
          • Open
          • OpenAsync
            • OpenAsync
            • OpenAsync(CancellationToken)
      • IAdoDbTransaction
        • Properties
          • DbTransaction
          • TransactionId
        • Methods
          • Commit
          • CommitAsync
            • CommitAsync
            • CommitAsync(CancellationToken)
          • Rollback
          • RollbackAsync
            • RollbackAsync
            • RollbackAsync(CancellationToken)
      • IAdoDbTransactionManager
        • Methods
          • BeginTransaction
            • BeginTransaction()
            • BeginTransaction(IsolationLevel)
          • BeginTransactionAsync
            • BeginTransactionAsync(CancellationToken)
            • BeginTransactionAsync(IsolationLevel, CancellationToken)
          • UseTransaction
      • ICloneable
        • Methods
          • Clone
      • IDataContextOptions
        • Properties
          • BatchExecuting
          • CommandTimeout
          • ConnectionString
          • DatabaseType
          • DelimitIdentifier
          • IsolationLevel
          • TrimSpaces
      • IDataContextOptions<T>
      • IDataIncludeGetter<T>
        • Methods
          • FirstOrDefault
          • Include
          • IncludeAll
          • ToList
      • IDataIncludeSetter<T>
        • Methods
          • Include
          • IncludeAll
      • IDataPacker
        • Properties
          • Count
          • Keys
        • Methods
          • AddDataTable
            • AddDataTable(IDataPacker, String, DataTable)
            • AddDataTable(IDataPacker, String, DataTable, Boolean)
          • AddModel
          • AddModelEntries
          • AddModels
          • AddRaw
          • AddValue
          • ContainsKey
          • GetTextString
          • RemoveKey
      • IDataUnPacker
        • Properties
          • Count
          • DataFormat
          • Keys
          • Raw
        • Methods
          • ContainsKey
          • GetDataTable
          • GetModel
          • GetModelEntries
            • GetModelEntries<T>(IDataUnpacker, String)
            • GetModelEntries<T>(IDataUnpacker, String, MappingMethod)
          • GetModels
          • GetRaw
          • RemoveKey
      • IDataTemplate
        • Methods
          • LoadContent
          • LoadFile
            • LoadFile(string)
            • LoadFile(string, Encoding)
          • SetParameter
        • Properties
          • Content
          • FilePath
      • IDBResult
        • Properties
          • AffectedCount
          • Cancelled
          • DeletedCount
          • InsertedCount
          • ModifiedCount
      • IModelEntry
        • Properties
          • ModelState
          • Properties
        • Methods
          • GetCurrentValue
          • GetOriginalValue
          • GetPropertyState
          • SetCurrentValue
        • Events
          • CurrentValueChanged
      • IModelEntry<T>
      • IPropertyInfo
        • Properties
          • DataType
          • Index
          • Name
      • ISaveContext
        • Properties
          • Count
          • LastDbResult
          • Names
        • Methods
          • Add
          • CancelSave
          • Contains
          • Get
          • Remove
          • RemoveAll
      • ISqlParameter
        • Properties
          • DataType
          • Direction
          • Name
      • MappingMethod
      • ModelSelector
      • ModelSqlBuilder
        • Properties
          • DeleteBuilder
          • DeleteSql
          • QueryBuilder
          • QuerySql
        • Methods
          • GetBuilder
          • GetQueryBuilder
          • GetQuerySql
      • ModelState
      • OutJoinSyntax
      • ParamValue
        • Properties
          • DataType
          • Direction
          • Name
          • Value
        • Methods
          • Input
            • Input<T>(string, TType)
            • Input(string, object, Type)
          • InputOutput
            • InputOutput(string, object, Type)
            • InputOutput<T>(string, TType)
          • New
            • New(String, Object)
            • New<T>(String, TType, ParameterDirection)
          • Output
            • Output<T>(string)
            • Output<T>(string, int)
            • Output(string, Type)
            • Output(string, int, Type)
          • ReturnValue
            • ReturnValue<T>(string)
            • ReturnValue(string, Type)
      • PropertiesState
      • QuerySelector
      • SaveStrategy
      • SetValueStrategy
      • SQLBinaryOperator
      • SqlJoinType
      • StateTrackable
      • TemplateExporter
        • Methods
      • UpdateSqlStrategy
      • UpdateWhereStrategy
    • SnapObjects.Data.AspNetCore (3.1.x)
      • CommitPolicy
      • IRollbackResult
      • RollbackResult
        • Constructors
          • RollbackResult
        • Methods
          • ExecuteResult
          • ExecuteResultAsync
        • Operators
          • Implicit
            • Implicit(TValue to RollbackResult<T>)
            • Implicit(ActionResult<T> to RollbackResult<T>)
      • TransactionAttribute
        • Constructors
          • TransactionAttribute
        • Properties
          • AsyncFlowOption
          • CommitPolicy
          • IsolationLevel
          • ScopeTimeout
        • Methods
          • OnActionExecuted
          • OnActionExecuting
          • OnResultExecuted
      • WebExtensions
        • Methods
          • AddGzipCompression
          • UseCoreIntegrated
          • UseTransaction
    • SnapObjects.Data.Informix
      • InformixDataContext
        • Constructors
          • InformixDataContext
            • InformixDataContext(IDataContextOptions)
            • InformixDataContext(DB2Connection)
      • InformixDataContextOptions
        • Constructors
          • InformixDataContextOptions
      • InformixDataContextOptions<T>
        • Constructors
          • InformixDataContextOptions
      • InformixExtensions
        • Methods
          • UseInformix<T>
            • UseInformix<T>(IDataContextOptions<T>, String)
            • UseInformix<T>(IDataContextOptions<T>, String, Action<InformixDataContextOptions<T>>)
            • UseInformix<T>(IDataContextOptions<T>, IConfiguration, String)
    • SnapObjects.Data.MySql
      • MySqlDataContext
        • Constructors
          • MySqlDataContext
            • MySqlDataContext(IDataContextOptions)
            • MySqlDataContext(MySqlConnection)
      • MySqlDataContextOptions
        • Constructors
          • MySqlDataContextOptions
        • Properties
          • IgnoreSpace
      • MySqlDataContextOptions<T>
        • Constructors
          • MySqlDataContextOptions
        • Properties
          • IgnoreSpace
      • MySqlExtensions
        • Methods
          • UseMySql<T>
            • UseMySql<T>(IDataContextOptions<T>, String)
            • UseMySql<T>(IDataContextOptions<T>, String, Action<MySqlDataContextOptions<T>>)
            • UseMySql<T>(IDataContextOptions<T>, IConfiguration, String)
    • SnapObjects.Data.Odbc
      • SAP ASE
        • OdbcAseDataContext
          • Constructors
            • OdbcAseDataContext
              • OdbcAseDataContext(IDataContextOptions)
              • OdbcAseDataContext(OdbcConnection)
        • OdbcAseDataContextOptions
          • Constructors
            • OdbcAseDataContextOptions
        • OdbcAseDataContextOptions_Generic
          • Constructors
            • OdbcAseDataContextOptions_Generic
        • OdbcAseExtensions
          • UseAse
      • SAP HANA
        • OdbcHanaDataContext
          • Constructors
            • OdbcHanaDataContext
              • OdbcHanaDataContext(IDataContextOptions)
              • OdbcHanaDataContext(OdbcConnection)
        • OdbcHanaDataContextOptions
          • Constructors
            • OdbcHanaDataContextOptions
        • OdbcHanaDataContextOptions_Generic
          • Constructors
            • OdbcHanaDataContextOptions_Generic
        • OdbcHanaExtensions
          • UseHana
      • SAP SQL Anywhere
        • OdbcSqlAnywhereDataContext
          • Constructors
            • OdbcSqlAnywhereDataContext
              • OdbcSqlAnywhereDataContext(IDataContextOptions)
              • OdbcSqlAnywhereDataContext(OdbcConnection)
        • OdbcSqlAnywhereDataContextOptions
          • Constructors
            • OdbcSqlAnywhereDataContextOptions
        • OdbcSqlAnywhereDataContextOptions_Generic
          • Constructors
            • OdbcSqlAnywhereDataContextOptions_Generic
        • OdbcSqlAnywhereExtensions
          • UseSqlAnywhere
    • SnapObjects.Data.Oracle
      • OracleDataContext
        • Constructors
          • OracleDataContext
            • OracleDataContext(IDataContextOptions)
            • OracleDataContext(OracleConnection)
      • OracleDataContextOptions
        • Constructors
          • OracleDataContextOptions
        • Properties
          • InitialLOBFetchSize
          • InitialLongFetchSize
          • SuppressGetDecimalInvalidCastException
      • OracleDataContextOptions<T>
        • Constructors
          • OracleDataContextOptions
      • OracleExtensions
        • Methods
          • UseOracle<T>
            • UseOracle<T>(IDataContextOptions<T>, String)
            • UseOracle<T>(IDataContextOptions<T>, String, Action<OracleDataContextOptions<T>>)
            • UseOracle<T>(IDataContextOptions<T>, IConfiguration, String)
      • ParamValueExtensions
        • Method
          • SetArrayBindSize(this ParamValue, int[])
    • SnapObjects.Data.PostgreSql
      • PostgreSqlDataContext
        • Constructors
          • PostgreSqlDataContext
            • PostgreSqlDataContext(IDataContextOptions)
            • PostgreSqlDataContext(PostgreSqlConnection)
      • PostgreSqlDataContextOptions
        • Constructors
          • PostgreSqlDataContextOptions
      • PostgreSqlDataContextOptions<T>
        • Constructors
          • PostgreSqlDataContextOptions
      • PostgreSqlExtensions
        • Methods
          • UsePostgreSql<T>
            • UsePostgreSql<T>(IDataContextOptions<T>, String)
            • UsePostgreSql<T>(IDataContextOptions<T>, String, Action<PostgreSqlDataContextOptions<T>>)
            • UsePostgreSql<T>(IDataContextOptions<T>, IConfiguration, String)
    • SnapObjects.Data.Sqlite
      • SqliteDataContext
        • Constructors
          • SqliteDataContext
            • SqliteDataContext(IDataContextOptions)
            • SqliteDataContext(SqliteConnection)
      • SqliteDataContextOptions
        • Constructors
          • SqliteDataContextOptions
      • SqliteDataContextOptions<T>
        • Constructors
          • SqliteDataContextOptions
      • SqliteExtensions
        • Methods
          • UseSqlite<T>
            • UseSqlite<T>(IDataContextOptions<T>, String)
            • UseSqlite<T>(IDataContextOptions<T>, String, Action<SqliteDataContextOptions<T>>)
            • UseSqlite<T>(IDataContextOptions<T>, IConfiguration, String)
    • SnapObjects.Data.SqlServer
      • SqlServerDataContext
        • Constructors
          • SqlServerDataContext
            • SqlServerDataContext(IDataContextOptions)
            • SqlServerDataContext(SqlServerConnection)
      • SqlServerDataContextOptions
        • Constructors
          • SqlServerDataContextOptions
      • SqlServerDataContextOptions<T>
        • Constructors
          • SqlServerDataContextOptions
      • SqlServerExtensions
        • Methods
          • UseSqlServer<T>
            • UseSqlServer<T>(IDataContextOptions<T>, String)
            • UseSqlServer<T>(IDataContextOptions<T>, String, Action<SqlServerDataContextOptions<T>>)
            • UseSqlServer<T>(IDataContextOptions<T>, IConfiguration, String)

    SqlServerDataContextOptions.SqlServerDataContextOptions(string connectionString) Constructor

    .NET Standard 2.x

    Initializes a new instance of the SqlServerDataContextOptions class by passing the connection string as a parameter.

    Namespace: SnapObjects.Data.SqlServer

    Assembly: SnapObjects.Data.SqlServer.dll

    Syntax

    public SqlServerDataContextOptions(string connectionString) : base(DatabaseType.SqlServer)
    

    Parameters

    connectionString System.String

    A string containing connection information about how to connect to the data source.

    Examples

    The following code example uses a connection string to initialize an instance of the SqlServerDataContextOptions class.

    using Appeon.ApiDoc.Models;
    using SnapObjects.Data;
    using SnapObjects.Data.SqlServer;
    using System;
    
    namespace Appeon.ApiDoc.SqlServerDataContextOptionsExamples
    {
        public class SqlServerDataContextOptionsExample
        {
            public void Example()
            {
                var options = new SqlServerDataContextOptions(CONNECTION_STRING);
    
                var dataContext = new SqlServerDataContext(options);
    
                Console.WriteLine(dataContext.ContextOptions.DatabaseType);
    
                /*This code produces the following output:
    
                SqlServer
                */
            }
        }
    }
    

    Applies to

    .NET Standard

    2.x

    In This Article
    • Syntax
    • Examples
    • Applies to
    Back to top Generated by Appeon