TableAttribute Class

Reference

Definition

Namespace:: System.Data.Linq.Mapping

Assembly:: System.Data.Linq.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class TableAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)]
public sealed class TableAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=false)>]
type TableAttribute = class
    inherit Attribute

Public NotInheritable Class TableAttribute
Inherits Attribute

Inheritance: Object

Attribute
TableAttribute

Attributes: AttributeUsageAttribute

Examples

[Table(Name = "Customers")]
public class Customer
{
    // ...
}

<Table(Name:="Customers")> _
Public Class Customer
    ' ...
End Class

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.

Note

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.

Constructors

TableAttribute()

Initializes a new instance of the TableAttribute class.

Properties

Name	Gets or sets the name of the table or view.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)

Applies to