weiai/FreeSql
1
0
Fork 0
mirror of https://github.com/dotnetcore/FreeSql.git synced 2026-02-24 17:20:58 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
83a5254b15885dd8a91a5f156e495335749e7bde
FreeSql/api/FreeSql.DataAnnotations.IndexAttribute.html
luoyunchong 83a5254b15 deploy: 108f65c3da
2023-07-07 17:27:43 +00:00

490 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class IndexAttribute
| FreeSql API Docs </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class IndexAttribute
| FreeSql API Docs ">
<meta name="generator" content="docfx 2.59.4.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src=".././images/logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="FreeSql.DataAnnotations.IndexAttribute">
<h1 id="FreeSql_DataAnnotations_IndexAttribute" data-uid="FreeSql.DataAnnotations.IndexAttribute" class="text-break">Class IndexAttribute
</h1>
<div class="markdown level0 summary"><p>索引设置，如：[Index(&quot;{tablename}_idx_01&quot;, &quot;name&quot;)]</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">System.Attribute</span></div>
<div class="level2"><span class="xref">IndexAttribute</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Attribute.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefaultAttribute()</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)</span>
</div>
<div>
<span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
</div>
<div>
<span class="xref">System.Attribute.Match(System.Object)</span>
</div>
<div>
<span class="xref">System.Attribute.TypeId</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="FreeSql.DataAnnotations.html">FreeSql.DataAnnotations</a></h6>
<h6><strong>Assembly</strong>: FreeSql.dll</h6>
<h5 id="FreeSql_DataAnnotations_IndexAttribute_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
public class IndexAttribute : Attribute</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute__ctor_System_String_System_String_.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute.%23ctor(System.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L18">View Source</a>
</span>
<a id="FreeSql_DataAnnotations_IndexAttribute__ctor_" data-uid="FreeSql.DataAnnotations.IndexAttribute.#ctor*"></a>
<h4 id="FreeSql_DataAnnotations_IndexAttribute__ctor_System_String_System_String_" data-uid="FreeSql.DataAnnotations.IndexAttribute.#ctor(System.String,System.String)">IndexAttribute(String, String)</h4>
<div class="markdown level1 summary"><p>索引设置，如：[Index(&quot;{tablename}_idx_01&quot;, &quot;name&quot;)]</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IndexAttribute(string name, string fields)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>索引名<p>v1.7.0 增加占位符 {TableName} 表名区分索引名 （解决 AsTable 分表 CodeFirst 导致索引名重复的问题）</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">fields</span></td>
<td><p>索引字段，为属性名以逗号分隔，如：Create_time ASC, Title ASC</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute__ctor_System_String_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute.%23ctor(System.String%2CSystem.String%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L29">View Source</a>
</span>
<a id="FreeSql_DataAnnotations_IndexAttribute__ctor_" data-uid="FreeSql.DataAnnotations.IndexAttribute.#ctor*"></a>
<h4 id="FreeSql_DataAnnotations_IndexAttribute__ctor_System_String_System_String_System_Boolean_" data-uid="FreeSql.DataAnnotations.IndexAttribute.#ctor(System.String,System.String,System.Boolean)">IndexAttribute(String, String, Boolean)</h4>
<div class="markdown level1 summary"><p>索引设置，如：[Index(&quot;{tablename}_idx_01&quot;, &quot;name&quot;, true)]</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IndexAttribute(string name, string fields, bool isUnique)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>索引名<p>v1.7.0 增加占位符 {TableName} 表名区分索引名 （解决 AsTable 分表 CodeFirst 导致索引名重复的问题）</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">fields</span></td>
<td><p>索引字段，为属性名以逗号分隔，如：Create_time ASC, Title ASC</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isUnique</span></td>
<td><p>是否唯一</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute_Fields.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute.Fields%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L43">View Source</a>
</span>
<a id="FreeSql_DataAnnotations_IndexAttribute_Fields_" data-uid="FreeSql.DataAnnotations.IndexAttribute.Fields*"></a>
<h4 id="FreeSql_DataAnnotations_IndexAttribute_Fields" data-uid="FreeSql.DataAnnotations.IndexAttribute.Fields">Fields</h4>
<div class="markdown level1 summary"><p>索引字段，为属性名以逗号分隔，如：Create_time ASC, Title ASC</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Fields { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute_IndexMethod.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute.IndexMethod%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L55">View Source</a>
</span>
<a id="FreeSql_DataAnnotations_IndexAttribute_IndexMethod_" data-uid="FreeSql.DataAnnotations.IndexAttribute.IndexMethod*"></a>
<h4 id="FreeSql_DataAnnotations_IndexAttribute_IndexMethod" data-uid="FreeSql.DataAnnotations.IndexAttribute.IndexMethod">IndexMethod</h4>
<div class="markdown level1 summary"><p>索引类型<p>
暂时只有 FreeSql.Provider.PostgreSQL 有效</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IndexMethod IndexMethod { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="FreeSql.DataAnnotations.IndexMethod.html">IndexMethod</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute_IsUnique.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute.IsUnique%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L49">View Source</a>
</span>
<a id="FreeSql_DataAnnotations_IndexAttribute_IsUnique_" data-uid="FreeSql.DataAnnotations.IndexAttribute.IsUnique*"></a>
<h4 id="FreeSql_DataAnnotations_IndexAttribute_IsUnique" data-uid="FreeSql.DataAnnotations.IndexAttribute.IsUnique">IsUnique</h4>
<div class="markdown level1 summary"><p>是否唯一</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsUnique { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute_Name.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L39">View Source</a>
</span>
<a id="FreeSql_DataAnnotations_IndexAttribute_Name_" data-uid="FreeSql.DataAnnotations.IndexAttribute.Name*"></a>
<h4 id="FreeSql_DataAnnotations_IndexAttribute_Name" data-uid="FreeSql.DataAnnotations.IndexAttribute.Name">Name</h4>
<div class="markdown level1 summary"><p>索引名<p>
v1.7.0 增加占位符 {TableName} 表名区分索引名 （解决 AsTable 分表 CodeFirst 导致索引名重复的问题）</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/dotnetcore/freesql/new/master/apiSpec/new?filename=FreeSql_DataAnnotations_IndexAttribute.md&amp;value=---%0Auid%3A%20FreeSql.DataAnnotations.IndexAttribute%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/dotnetcore/FreeSql/blob/master/FreeSql/DataAnnotations/IndexAttribute.cs/#L10" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink