Files
tgstation-server/_sql_server_database_context_8cs_source.html
T

120 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>tgstation-server: src/Tgstation.Server.Host/Database/SqlServerDatabaseContext.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="tgs.ico"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">tgstation-server
&#160;<span id="projectnumber">4.4.0</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="features.html"><span>Features</span></a></li>
<li><a href="api.html"><span>API</span></a></li>
<li><a href="architecture.html"><span>Architecture</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_3a3ab2f663730d5bed7026cf41734e8a.html">Database</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SqlServerDatabaseContext.cs</div> </div>
</div><!--header-->
<div class="contents">
<a href="_sql_server_database_context_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="keyword">using</span> Microsoft.EntityFrameworkCore;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="keyword">using</span> <a class="code" href="namespace_system.html">System</a>;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="keyword">using</span> <a class="code" href="namespace_tgstation.html">Tgstation</a>.<a class="code" href="namespace_tgstation_1_1_server.html">Server</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host.html">Host</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html">Configuration</a>;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_tgstation.html">Tgstation</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a0a41c646f859c99d437373d8e6e0545ba9aa1b03934893d7134a660af4204f2a9">Server</a>.Host.Database</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;{</div><div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html"> 10</a></span>&#160; sealed <span class="keyword">class </span><a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html">SqlServerDatabaseContext</a> : <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context.html">DatabaseContext</a></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; {</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html#a0d17265d1aab0819b7891c9cc29e5ab9"> 16</a></span>&#160; <span class="keyword">public</span> <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html#a0d17265d1aab0819b7891c9cc29e5ab9">SqlServerDatabaseContext</a>(DbContextOptions&lt;SqlServerDatabaseContext&gt; dbContextOptions) : base(dbContextOptions)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; { }</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html#ac5686cbb48dd4d5fae19a104daa4e6a9"> 24</a></span>&#160; <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html#ac5686cbb48dd4d5fae19a104daa4e6a9">ConfigureWith</a>(DbContextOptionsBuilder options, <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration.html">DatabaseConfiguration</a> databaseConfiguration)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">if</span> (options == null)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(options));</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">if</span> (databaseConfiguration == null)</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(databaseConfiguration));</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (databaseConfiguration.<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration.html#adab83eaad53afabdb2f7b43c23ece38a">DatabaseType</a> != <a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html#acda8f6ee23a9ee8ac298f7b4a7d5617c">DatabaseType</a>.SqlServer)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException($<span class="stringliteral">&quot;Invalid DatabaseType for {nameof(SqlServerDatabaseContext)}!&quot;</span>);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; options.UseSqlServer(databaseConfiguration.<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration.html#a53a14b4a89de73b8ea223804c4aea365">ConnectionString</a>, x =&gt; x.EnableRetryOnFailure());</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;}</div><div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration_html_a53a14b4a89de73b8ea223804c4aea365"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration.html#a53a14b4a89de73b8ea223804c4aea365">Tgstation.Server.Host.Configuration.DatabaseConfiguration.ConnectionString</a></div><div class="ttdeci">string ConnectionString</div><div class="ttdoc">The connection string for the database </div><div class="ttdef"><b>Definition:</b> <a href="_database_configuration_8cs_source.html#l00030">DatabaseConfiguration.cs:30</a></div></div>
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_api_1_1_models_html_a0a41c646f859c99d437373d8e6e0545ba9aa1b03934893d7134a660af4204f2a9"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a0a41c646f859c99d437373d8e6e0545ba9aa1b03934893d7134a660af4204f2a9">Tgstation.Server.Api.Models.IrcPasswordType.Server</a></div><div class="ttdoc">Use server authentication </div></div>
<div class="ttc" id="namespace_system_html"><div class="ttname"><a href="namespace_system.html">System</a></div></div>
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_database_context.html">Tgstation.Server.Host.Database.DatabaseContext</a></div><div class="ttdoc">Backend abstract implementation of IDatabaseContext </div><div class="ttdef"><b>Definition:</b> <a href="_database_context_8cs_source.html#l00022">DatabaseContext.cs:22</a></div></div>
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration_html_adab83eaad53afabdb2f7b43c23ece38a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration.html#adab83eaad53afabdb2f7b43c23ece38a">Tgstation.Server.Host.Configuration.DatabaseConfiguration.DatabaseType</a></div><div class="ttdeci">DatabaseType DatabaseType</div><div class="ttdoc">The Configuration.DatabaseType to create </div><div class="ttdef"><b>Definition:</b> <a href="_database_configuration_8cs_source.html#l00020">DatabaseConfiguration.cs:20</a></div></div>
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context_html_ac5686cbb48dd4d5fae19a104daa4e6a9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html#ac5686cbb48dd4d5fae19a104daa4e6a9">Tgstation.Server.Host.Database.SqlServerDatabaseContext.ConfigureWith</a></div><div class="ttdeci">static void ConfigureWith(DbContextOptionsBuilder options, DatabaseConfiguration databaseConfiguration)</div><div class="ttdoc">Configure the SqlServerDatabaseContext. </div><div class="ttdef"><b>Definition:</b> <a href="_sql_server_database_context_8cs_source.html#l00024">SqlServerDatabaseContext.cs:24</a></div></div>
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_configuration_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html">Tgstation.Server.Host.Configuration</a></div><div class="ttdef"><b>Definition:</b> <a href="_control_panel_configuration_8cs_source.html#l00003">ControlPanelConfiguration.cs:3</a></div></div>
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context_html_a0d17265d1aab0819b7891c9cc29e5ab9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html#a0d17265d1aab0819b7891c9cc29e5ab9">Tgstation.Server.Host.Database.SqlServerDatabaseContext.SqlServerDatabaseContext</a></div><div class="ttdeci">SqlServerDatabaseContext(DbContextOptions&lt; SqlServerDatabaseContext &gt; dbContextOptions)</div><div class="ttdoc">Construct a SqlServerDatabaseContext </div><div class="ttdef"><b>Definition:</b> <a href="_sql_server_database_context_8cs_source.html#l00016">SqlServerDatabaseContext.cs:16</a></div></div>
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_configuration_1_1_database_configuration.html">Tgstation.Server.Host.Configuration.DatabaseConfiguration</a></div><div class="ttdoc">Configuration options for the Database.DatabaseContext </div><div class="ttdef"><b>Definition:</b> <a href="_database_configuration_8cs_source.html#l00009">DatabaseConfiguration.cs:9</a></div></div>
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_configuration_html_acda8f6ee23a9ee8ac298f7b4a7d5617c"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_configuration.html#acda8f6ee23a9ee8ac298f7b4a7d5617c">Tgstation.Server.Host.Configuration.DatabaseType</a></div><div class="ttdeci">DatabaseType</div><div class="ttdoc">Type of database to user </div><div class="ttdef"><b>Definition:</b> <a href="_database_type_8cs_source.html#l00006">DatabaseType.cs:6</a></div></div>
<div class="ttc" id="namespace_tgstation_1_1_server_html"><div class="ttname"><a href="namespace_tgstation_1_1_server.html">Tgstation.Server</a></div></div>
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_database_1_1_sql_server_database_context.html">Tgstation.Server.Host.Database.SqlServerDatabaseContext</a></div><div class="ttdoc">DatabaseContext for Sqlserver </div><div class="ttdef"><b>Definition:</b> <a href="_sql_server_database_context_8cs_source.html#l00010">SqlServerDatabaseContext.cs:10</a></div></div>
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host.html">Tgstation.Server.Host</a></div></div>
<div class="ttc" id="namespace_tgstation_html"><div class="ttname"><a href="namespace_tgstation.html">Tgstation</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>