545 lines
16 KiB
HTML
545 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<title>Class MongoServer | HiAPI-C# 2025 </title>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="title" content="Class MongoServer | HiAPI-C# 2025 ">
|
||
|
||
<meta name="description" content="A MongoDB runner that manages MongoDB processes.">
|
||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||
<link rel="stylesheet" href="../public/main.css">
|
||
<meta name="docfx:navrel" content="../toc.html">
|
||
<meta name="docfx:tocrel" content="toc.html">
|
||
|
||
<meta name="docfx:rel" content="../">
|
||
|
||
|
||
|
||
<meta name="loc:inThisArticle" content="In this article">
|
||
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
||
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
||
<meta name="loc:tocFilter" content="Filter by title">
|
||
<meta name="loc:nextArticle" content="Next">
|
||
<meta name="loc:prevArticle" content="Previous">
|
||
<meta name="loc:themeLight" content="Light">
|
||
<meta name="loc:themeDark" content="Dark">
|
||
<meta name="loc:themeAuto" content="Auto">
|
||
<meta name="loc:changeTheme" content="Change theme">
|
||
<meta name="loc:copy" content="Copy">
|
||
<meta name="loc:downloadPdf" content="Download PDF">
|
||
|
||
<script type="module" src="./../public/docfx.min.js"></script>
|
||
|
||
<script>
|
||
const theme = localStorage.getItem('theme') || 'auto'
|
||
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
||
</script>
|
||
|
||
</head>
|
||
|
||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||
<header class="bg-body border-bottom">
|
||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||
<div class="container-xxl flex-nowrap">
|
||
<a class="navbar-brand" href="../index.html">
|
||
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
|
||
|
||
</a>
|
||
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
||
<i class="bi bi-three-dots"></i>
|
||
</button>
|
||
<div class="collapse navbar-collapse" id="navpanel">
|
||
<div id="navbar">
|
||
<form class="search" role="search" id="search">
|
||
<i class="bi bi-search"></i>
|
||
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
||
</form>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
</header>
|
||
|
||
<main class="container-xxl">
|
||
<div class="toc-offcanvas">
|
||
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
||
<div class="offcanvas-header">
|
||
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
||
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
||
</div>
|
||
<div class="offcanvas-body">
|
||
<nav class="toc" id="toc"></nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="content">
|
||
<div class="actionbar">
|
||
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
||
<i class="bi bi-list"></i>
|
||
</button>
|
||
|
||
<nav id="breadcrumb"></nav>
|
||
</div>
|
||
|
||
<article data-uid="Hi.MongoUtils.MongoServer">
|
||
|
||
|
||
|
||
<h1 id="Hi_MongoUtils_MongoServer" data-uid="Hi.MongoUtils.MongoServer" class="text-break">
|
||
Class MongoServer
|
||
</h1>
|
||
|
||
<div class="facts text-secondary">
|
||
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.MongoUtils.html">MongoUtils</a></dd></dl>
|
||
<dl><dt>Assembly</dt><dd>HiNc.dll</dd></dl>
|
||
</div>
|
||
|
||
<div class="markdown summary"><p>A MongoDB runner that manages MongoDB processes.</p>
|
||
</div>
|
||
<div class="markdown conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public class MongoServer : IMongoRunner, IDisposable</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<dl class="typelist inheritance">
|
||
<dt>Inheritance</dt>
|
||
<dd>
|
||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||
<div><span class="xref">MongoServer</span></div>
|
||
</dd>
|
||
</dl>
|
||
|
||
<dl class="typelist implements">
|
||
<dt>Implements</dt>
|
||
<dd>
|
||
<div><a class="xref" href="Hi.MongoUtils.IMongoRunner.html">IMongoRunner</a></div>
|
||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
<dl class="typelist inheritedMembers">
|
||
<dt>Inherited Members</dt>
|
||
<dd>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="typelist extensionMethods">
|
||
<dt>Extension Methods</dt>
|
||
<dd>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
||
</div>
|
||
<div>
|
||
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
|
||
|
||
|
||
|
||
<h2 class="section" id="properties">Properties
|
||
</h2>
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_ConnectionString_" data-uid="Hi.MongoUtils.MongoServer.ConnectionString*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_ConnectionString" data-uid="Hi.MongoUtils.MongoServer.ConnectionString">
|
||
ConnectionString
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Gets the connection string to the MongoDB instance.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public string ConnectionString { get; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_Default_" data-uid="Hi.MongoUtils.MongoServer.Default*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_Default" data-uid="Hi.MongoUtils.MongoServer.Default">
|
||
Default
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Gets or sets the default MongoDB server instance.
|
||
If not explicitly set, it will be automatically created.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public static MongoServer Default { get; set; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="Hi.MongoUtils.MongoServer.html">MongoServer</a></dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_IsDefaultInit_" data-uid="Hi.MongoUtils.MongoServer.IsDefaultInit*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_IsDefaultInit" data-uid="Hi.MongoUtils.MongoServer.IsDefaultInit">
|
||
IsDefaultInit
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Gets a value indicating whether the default MongoDB instance has been initialized.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public static bool IsDefaultInit { get; }</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Property Value</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||
<dd></dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h2 class="section" id="methods">Methods
|
||
</h2>
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_CheckMongoHealth_" data-uid="Hi.MongoUtils.MongoServer.CheckMongoHealth*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_CheckMongoHealth" data-uid="Hi.MongoUtils.MongoServer.CheckMongoHealth">
|
||
CheckMongoHealth()
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>執行MongoDB健康檢查，確認進程存活且可響應連接</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public bool CheckMongoHealth()</code></pre>
|
||
</div>
|
||
|
||
|
||
<h4 class="section">Returns</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||
<dd><p>如果MongoDB運行正常則返回true</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_Dispose_" data-uid="Hi.MongoUtils.MongoServer.Dispose*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_Dispose" data-uid="Hi.MongoUtils.MongoServer.Dispose">
|
||
Dispose()
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Stops the MongoDB instance and cleans up resources.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_Dispose_" data-uid="Hi.MongoUtils.MongoServer.Dispose*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_Dispose_System_Boolean_" data-uid="Hi.MongoUtils.MongoServer.Dispose(System.Boolean)">
|
||
Dispose(bool)
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Stops the MongoDB instance and cleans up resources.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
|
||
</div>
|
||
|
||
<h4 class="section">Parameters</h4>
|
||
<dl class="parameters">
|
||
<dt><code>disposing</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||
<dd><p>Whether this method is being called from Dispose().</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_Finalize_" data-uid="Hi.MongoUtils.MongoServer.Finalize*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_Finalize" data-uid="Hi.MongoUtils.MongoServer.Finalize">
|
||
~MongoServer()
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Finalizer to ensure resources are cleaned up.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">protected ~MongoServer()</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_GetMongoProcessId_" data-uid="Hi.MongoUtils.MongoServer.GetMongoProcessId*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_GetMongoProcessId" data-uid="Hi.MongoUtils.MongoServer.GetMongoProcessId">
|
||
GetMongoProcessId()
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>獲取MongoDB進程ID</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public int? GetMongoProcessId()</code></pre>
|
||
</div>
|
||
|
||
|
||
<h4 class="section">Returns</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>?</dt>
|
||
<dd><p>MongoDB進程ID，如果進程不存在則返回null</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_IsMongoProcessRunning_" data-uid="Hi.MongoUtils.MongoServer.IsMongoProcessRunning*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_IsMongoProcessRunning" data-uid="Hi.MongoUtils.MongoServer.IsMongoProcessRunning">
|
||
IsMongoProcessRunning()
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>檢查MongoDB進程是否仍在運行</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public bool IsMongoProcessRunning()</code></pre>
|
||
</div>
|
||
|
||
|
||
<h4 class="section">Returns</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||
<dd><p>如果MongoDB進程仍在運行則返回true</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="Hi_MongoUtils_MongoServer_Run_" data-uid="Hi.MongoUtils.MongoServer.Run*"></a>
|
||
|
||
<h3 id="Hi_MongoUtils_MongoServer_Run_Hi_MongoUtils_MongoRunnerOptions_" data-uid="Hi.MongoUtils.MongoServer.Run(Hi.MongoUtils.MongoRunnerOptions)">
|
||
Run(MongoRunnerOptions)
|
||
|
||
</h3>
|
||
|
||
<div class="markdown level1 summary"><p>Runs a MongoDB instance with the specified options.</p>
|
||
</div>
|
||
<div class="markdown level1 conceptual"></div>
|
||
|
||
<div class="codewrapper">
|
||
<pre><code class="lang-csharp hljs">public static MongoServer Run(MongoRunnerOptions options = null)</code></pre>
|
||
</div>
|
||
|
||
<h4 class="section">Parameters</h4>
|
||
<dl class="parameters">
|
||
<dt><code>options</code> <a class="xref" href="Hi.MongoUtils.MongoRunnerOptions.html">MongoRunnerOptions</a></dt>
|
||
<dd><p>The MongoDB runner options.</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
<h4 class="section">Returns</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="Hi.MongoUtils.MongoServer.html">MongoServer</a></dt>
|
||
<dd><p>A MongoDB runner instance.</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h4 class="section">Exceptions</h4>
|
||
<dl class="parameters">
|
||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timeoutexception">TimeoutException</a></dt>
|
||
<dd><p>Thrown when connecting to MongoDB times out.</p>
|
||
</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
</article>
|
||
|
||
<div class="contribution d-print-none">
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="affix">
|
||
<nav id="affix"></nav>
|
||
</div>
|
||
</main>
|
||
|
||
<div class="container-xxl search-results" id="search-results"></div>
|
||
|
||
<footer class="border-top text-secondary">
|
||
<div class="container-xxl">
|
||
<div class="flex-fill">
|
||
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html>
|