Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
D
Dapper
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
tsai
Dapper
Commits
11ec77ea
Commit
11ec77ea
authored
Jan 19, 2017
by
Mark Bell
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update README with documentation for [ExplicitKey] attribute
parent
23e6b64c
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
36 additions
and
7 deletions
+36
-7
Readme.md
Dapper.Contrib/Readme.md
+36
-7
No files found.
Dapper.Contrib/Readme.md
View file @
11ec77ea
...
@@ -21,15 +21,21 @@ bool DeleteAll<T>();
...
@@ -21,15 +21,21 @@ bool DeleteAll<T>();
```
```
For these extensions to work, the entity in question _MUST_ have a
For these extensions to work, the entity in question _MUST_ have a
key-property, a property named "
`id`
" or decorated with a
`[Key]`
attribute.
key property. Dapper will automatically use a property named "
`id`
"
(case-insensitive) as the key property, if one is present.
```
csharp
```
csharp
public
class
Car
public
class
Car
{
{
public
int
Id
{
get
;
set
;
}
public
int
Id
{
get
;
set
;
}
// Works by convention
public
string
Name
{
get
;
set
;
}
public
string
Name
{
get
;
set
;
}
}
}
```
If the entity doesn't follow this convention, decorate
a specific property with a
`[Key]`
or
`[ExplicitKey]`
attribute.
```
csharp
public
class
User
public
class
User
{
{
[
Key
]
[
Key
]
...
@@ -39,6 +45,9 @@ public class User
...
@@ -39,6 +45,9 @@ public class User
}
}
```
```
`[Key]`
should be used for database-generated keys (e.g. autoincrement columns),
while
`[ExplicitKey]`
should be used for explicit keys generated in code.
`Get` methods
`Get` methods
-------
-------
...
@@ -119,7 +128,27 @@ Dapper.Contrib makes use of some optional attributes:
...
@@ -119,7 +128,27 @@ Dapper.Contrib makes use of some optional attributes:
public string Name { get; set; }
public string Name { get; set; }
}
}
```
```
*
`[Key]`
- this property is the identity/key (unless it is named "Id")
*
`[Key]`
- this property represents a database-generated identity/key
```
csharp
public
class
Employee
{
[
Key
]
public
int
EmployeeId
{
get
;
set
;
}
public
string
Name
{
get
;
set
;
}
}
```
*
`[ExplicitKey]`
- this property represents an explicit identity/key which is
*not*
automatically generated by the database
```csharp
public class Employee
{
[ExplicitKey]
public Guid EmployeeId { get; set; }
public string Name { get; set; }
}
```
*
`[Write(true/false)]`
- this property is (not) writeable
*
`[Write(true/false)]`
- this property is (not) writeable
*
`[Computed]`
- this property is computed and should not be part of updates
*
`[Computed]`
- this property is computed and should not be part of updates
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment