176 lines
9.8 KiB
XML
176 lines
9.8 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Mongo2Go</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="M:Mongo2Go.Helper.FolderSearch.FinalizePath(System.String)">
|
|
<summary>
|
|
Absolute path stays unchanged, relative path will be relative to current executing directory (usually the /bin folder)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.IPortPool.GetNextOpenPort">
|
|
<summary>
|
|
Returns and reserves a new port
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.MongodArguments.GetValidAdditionalArguments(System.String,System.String)">
|
|
<summary>
|
|
Returns the <paramref name="additionalMongodArguments" /> if it is verified that it does not contain any mongod argument already defined by Mongo2Go.
|
|
</summary>
|
|
<param name="existingMongodArguments">mongod arguments defined by Mongo2Go</param>
|
|
<param name="additionalMongodArguments">Additional mongod arguments</param>
|
|
<exception cref="T:System.ArgumentException"><paramref name="additionalMongodArguments" /> contains at least one mongod argument already defined by Mongo2Go</exception>
|
|
<returns>A string with the additional mongod arguments</returns>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.MongoDbProcessStarter.Start(System.String,System.String,System.Int32,System.Boolean,System.String,System.UInt16,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Starts a new process. Process can be killed
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.MongoDbProcessStarter.Start(System.String,System.String,System.Int32,System.Boolean,System.Boolean,System.String,System.UInt16,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Starts a new process.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.MongoImportExport.Import(System.String,System.Int32,System.String,System.String,System.String,System.Boolean,System.String)">
|
|
<summary>
|
|
Input File: Absolute path stays unchanged, relative path will be relative to current executing directory (usually the /bin folder)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.MongoImportExport.Export(System.String,System.Int32,System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Output File: Absolute path stays unchanged, relative path will be relative to current executing directory (usually the /bin folder)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mongo2Go.Helper.MongoLogStatement">
|
|
<summary>
|
|
Structure of a log generated by mongod. Used to deserialize the logs
|
|
and pass them to an ILogger.
|
|
See: https://docs.mongodb.com/manual/reference/log-messages/#json-log-output-format
|
|
Note: "truncated" and "size" are not parsed as we're unsure how to
|
|
properly parse and use them.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mongo2Go.Helper.MongoLogStatement.Severity">
|
|
<summary>
|
|
Severity of the logs as defined by MongoDB. Mapped to LogLevel
|
|
as defined by Microsoft.
|
|
D1-D2 mapped to Debug level. D3-D5 mapped Trace level.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mongo2Go.Helper.PortPool">
|
|
<summary>
|
|
Intention: port numbers won't be assigned twice to avoid connection problems with integration tests
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.PortPool.GetNextOpenPort">
|
|
<summary>
|
|
Returns and reserves a new port
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.ProcessControl.StartAndWaitForReady(System.Diagnostics.Process,System.Int32,System.String,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Reads from Output stream to determine if process is ready
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.ProcessControl.WireLogsToConsoleAndDebugOutput(System.Diagnostics.Process)">
|
|
<summary>
|
|
Send the mongod process logs to .NET's console and debug outputs.
|
|
</summary>
|
|
<param name="process"></param>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.ProcessControl.WireLogsToLogger(System.Diagnostics.Process,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Parses and redirects mongod logs to ILogger.
|
|
</summary>
|
|
<param name="process"></param>
|
|
<param name="logger"></param>
|
|
</member>
|
|
<member name="T:Mongo2Go.Helper.StringFormatExtension">
|
|
<summary>
|
|
saves about 40 keystrokes
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.StringFormatExtension.Formatted(System.String,System.Object[])">
|
|
<summary>
|
|
Populates the template using the provided arguments and the invariant culture
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.Helper.StringFormatExtension.Formatted(System.String,System.IFormatProvider,System.Object[])">
|
|
<summary>
|
|
Populates the template using the provided arguments using the provided formatter
|
|
</summary>
|
|
</member>
|
|
<member name="T:Mongo2Go.MongoDbRunner">
|
|
<summary>
|
|
Mongo2Go main entry point
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mongo2Go.MongoDbRunner.State">
|
|
<summary>
|
|
State of the current MongoDB instance
|
|
</summary>
|
|
</member>
|
|
<member name="P:Mongo2Go.MongoDbRunner.ConnectionString">
|
|
<summary>
|
|
Connections string that should be used to establish a connection the MongoDB instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.Start(System.String,System.String,System.String,System.Boolean,System.String,System.UInt16,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
Starts Multiple MongoDB instances with each call
|
|
On dispose: kills them and deletes their data directory
|
|
</summary>
|
|
<param name="logger">(Optional) If null, mongod logs are wired to .NET's Console and Debug output (provided you haven't added the --quiet additional argument).
|
|
If not null, mongod logs are parsed and wired to the provided logger.</param>
|
|
<remarks>Should be used for integration tests</remarks>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.StartUnitTest(Mongo2Go.Helper.IPortPool,Mongo2Go.Helper.IFileSystem,Mongo2Go.Helper.IMongoDbProcessStarter,Mongo2Go.Helper.IMongoBinaryLocator,System.String,System.String)">
|
|
<summary>
|
|
!!!
|
|
This method is only used for an internal unit test. Use MongoDbRunner.Start() instead.
|
|
But if you find it to be useful (eg. to change every aspect on your own) feel free to implement the interfaces on your own!
|
|
</summary>
|
|
<remarks>see https://github.com/Mongo2Go/Mongo2Go/issues/41 </remarks>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.StartForDebugging(System.String,System.String,System.String,System.Boolean,System.Int32,System.String,System.UInt16)">
|
|
<summary>
|
|
Only starts one single MongoDB instance (even on multiple calls), does not kill it, does not delete data
|
|
</summary>
|
|
<remarks>
|
|
Should be used for local debugging only
|
|
WARNING: one single instance on one single machine is not a suitable setup for productive environments!!!
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.StartForDebuggingUnitTest(Mongo2Go.Helper.IProcessWatcher,Mongo2Go.Helper.IPortWatcher,Mongo2Go.Helper.IFileSystem,Mongo2Go.Helper.IMongoDbProcessStarter,Mongo2Go.Helper.IMongoBinaryLocator,System.String,System.String)">
|
|
<summary>
|
|
!!!
|
|
This method is only used for an internal unit test. Use MongoDbRunner.StartForDebugging() instead.
|
|
But if you find it to be useful (eg. to change every aspect on your own) feel free to implement the interfaces on your own!
|
|
</summary>
|
|
<remarks>see https://github.com/Mongo2Go/Mongo2Go/issues/41 </remarks>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.Import(System.String,System.String,System.String,System.Boolean,System.String)">
|
|
<summary>
|
|
Executes Mongoimport on the associated MongoDB Instace
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.Export(System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Executes Mongoexport on the associated MongoDB Instace
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.#ctor(Mongo2Go.Helper.IProcessWatcher,Mongo2Go.Helper.IPortWatcher,Mongo2Go.Helper.IFileSystem,Mongo2Go.Helper.IMongoDbProcessStarter,Mongo2Go.Helper.IMongoBinaryLocator,System.Int32,System.String,System.Boolean,System.String,System.UInt16)">
|
|
<summary>
|
|
usage: local debugging
|
|
</summary>
|
|
</member>
|
|
<member name="M:Mongo2Go.MongoDbRunner.#ctor(Mongo2Go.Helper.IPortPool,Mongo2Go.Helper.IFileSystem,Mongo2Go.Helper.IMongoDbProcessStarter,Mongo2Go.Helper.IMongoBinaryLocator,System.String,System.Boolean,System.String,System.UInt16,Microsoft.Extensions.Logging.ILogger)">
|
|
<summary>
|
|
usage: integration tests
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|