Skip to content

Commit

Permalink
SQL query doc improvements (#4042)
Browse files Browse the repository at this point in the history
* Rename "raw SQL" to "SQL queries"
* Switch to showing the new `FromSql` by default.
* Clearly document FromSqlRaw as appropriate only for dynamic SQL scenarios.
* Document SqlQuery
* Document ExecuteSql

Closes #3971
Closes #4041
Closes #1787
  • Loading branch information
roji authored Sep 20, 2022
1 parent d386dd2 commit 492544f
Show file tree
Hide file tree
Showing 12 changed files with 228 additions and 132 deletions.
5 changes: 5 additions & 0 deletions .openpublishing.redirection.json
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,11 @@
"source_path": "entity-framework/core/managing-schemas/scaffolding.md",
"redirect_url": "/ef/core/managing-schemas/scaffolding/index",
"redirect_document_id": false
},
{
"source_path": "entity-framework/core/querying/raw-sql.md",
"redirect_url": "/ef/core/querying/sql-queries",
"redirect_document_id": false
}
]
}
2 changes: 1 addition & 1 deletion entity-framework/core/modeling/keyless-entity-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ However, they are different from regular entity types in that they:

Some of the main usage scenarios for keyless entity types are:

- Serving as the return type for [raw SQL queries](xref:core/querying/raw-sql).
- Serving as the return type for [SQL queries](xref:core/querying/sql-queries).
- Mapping to database views that do not contain a primary key.
- Mapping to tables that do not have a primary key defined.
- Mapping to queries defined in the model.
Expand Down
4 changes: 2 additions & 2 deletions entity-framework/core/performance/efficient-querying.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,11 @@ Here are the results for a benchmark comparing tracking vs. no-tracking behavior

Finally, it is possible to perform updates without the overhead of change tracking, by utilizing a no-tracking query and then attaching the returned instance to the context, specifying which changes are to be made. This transfers the burden of change tracking from EF to the user, and should only be attempted if the change tracking overhead has been shown to be unacceptable via profiling or benchmarking.

## Using raw SQL
## Using SQL queries

In some cases, more optimized SQL exists for your query, which EF does not generate. This can happen when the SQL construct is an extension specific to your database that's unsupported, or simply because EF does not translate to it yet. In these cases, writing SQL by hand can provide a substantial performance boost, and EF supports several ways to do this.

* Use raw SQL [directly in your query](xref:core/querying/raw-sql), e.g. via <xref:Microsoft.EntityFrameworkCore.RelationalQueryableExtensions.FromSqlRaw%2A>. EF even lets you compose over the raw SQL with regular LINQ queries, allowing you to express only a part of the query in raw SQL. This is a good technique when the raw SQL only needs to be used in a single query in your codebase.
* Use SQL queries [directly in your query](xref:core/querying/sql-queries), e.g. via <xref:Microsoft.EntityFrameworkCore.RelationalQueryableExtensions.FromSqlRaw%2A>. EF even lets you compose over the SQL with regular LINQ queries, allowing you to express only a part of the query in SQL. This is a good technique when the SQL only needs to be used in a single query in your codebase.
* Define a [user-defined function](xref:core/querying/database-functions) (UDF), and then call that from your queries. Note that since 5.0, EF allows UDFs to return full resultsets - these are known as table-valued functions (TVFs) - and also allows mapping a `DbSet` to a function, making it look just like just another table.
* Define a database view and query from it in your queries. Note that unlike functions, views cannot accept parameters.

Expand Down
99 changes: 0 additions & 99 deletions entity-framework/core/querying/raw-sql.md

This file was deleted.

Loading

0 comments on commit 492544f

Please sign in to comment.