.NET Framework Class Library
TableAttribute Class

Designates a class as an entity class that is associated with a database table.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Data.Linq.MappingTableAttribute

Namespace:   System.Data.Linq.Mapping
Assembly:  System.Data.Linq (in System.Data.Linq.dll)
Syntax
<[%$TOPIC/bb534395_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/bb534395_en-us_VS_110_2_0_0_0_1%].Class, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class TableAttribute _
	Inherits [%$TOPIC/bb534395_en-us_VS_110_2_0_0_0_2%]
[[%$TOPIC/bb534395_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/bb534395_en-us_VS_110_2_0_1_0_1%].Class, AllowMultiple = false, Inherited = false)]
public sealed class TableAttribute : [%$TOPIC/bb534395_en-us_VS_110_2_0_1_0_2%]
[[%$TOPIC/bb534395_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/bb534395_en-us_VS_110_2_0_2_0_1%]::Class, AllowMultiple = false, Inherited = false)]
public ref class TableAttribute sealed : public [%$TOPIC/bb534395_en-us_VS_110_2_0_2_0_2%]
[<[%$TOPIC/bb534395_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/bb534395_en-us_VS_110_2_0_3_0_1%]([%$TOPIC/bb534395_en-us_VS_110_2_0_3_0_2%].Class, AllowMultiple = false, Inherited = false)>]
type TableAttribute =  
    class 
        inherit [%$TOPIC/bb534395_en-us_VS_110_2_0_3_0_3%] 
    end
public final class TableAttribute extends [%$TOPIC/bb534395_en-us_VS_110_2_0_4_0_0%]

The TableAttribute type exposes the following members.

Constructors
  NameDescription
Public method TableAttributeInitializes a new instance of the TableAttribute class.
Top
Properties
  NameDescription
Public property NameGets or sets the name of the table or view.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

Use this attribute to designate a class as an entity class that is associated with a database table or view. LINQ to SQL treats classes that have the TableAttribute attribute as persistent classes.

LINQ to SQL supports only single-table mapping. That is, an entity class must be mapped to exactly one database table, and you cannot map a database table to multiple classes at the same time.

You can use the Name property of the TableAttribute attribute to specify a name for the table, and you can optionally use the schema name to qualify a table name. If you do not specify a name by using the Name property, the table name is assumed to be the same as the class name.

Schema-qualified Names

You can optionally use the schema name to qualify a table name. By default, the token to the left of the first period in the Name string is considered to be the schema name. The remainder of the name is considered to be the table name. The provider quotes the table name as appropriate. For example, the LINQ to SQL provider for SQL Server makes sure that brackets are used at least where they are needed.

NoteNote

In some cases, you must explicitly quote attributes because the SQL Server provider cannot auto-quote. The following table shows some examples.

Case

Example: Identifier Name

Example: Expected String in Attributes

Otherwise…

Schema name contains a period

Schema: "A.B"

Table: "C"

"[A.B].C"

The first period is assumed to separate the schema name from the table name.

Schema/Table name starts with @

"@SomeName"

"[@SomeName]"

Assumed to be a parameter name.

Schema starts with [ and ends with ]

"[Schema.Table]"

"[[Schema].[Table]]]"

The unquoted identifier resembles a quoted identifier.

Table starts with [ and ends with ]

"[Table]"

"[[Table]]]"

The unquoted identifier resembles a quoted identifier.

Examples
<Table(Name:="Customers")> _
Public Class Customer
    ' ... 
End Class
[Table(Name = "Customers")]
public class Customer
{
    // ...
}
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.