Add Connection String Operation

RavenDB connection strings are used by RavenDB RavenDB ETL Tasks.

Example:

// Define a connection string to a RavenDB database destination
// ============================================================
var ravenDBConStr = new RavenConnectionString
{
    Name = "ravendb-connection-string-name",
    Database = "target-database-name",
    TopologyDiscoveryUrls = new[] { "https://rvn2:8080" }
};

// Deploy (send) the connection string to the server via the PutConnectionStringOperation
// ======================================================================================
var PutConnectionStringOp = new PutConnectionStringOperation<RavenConnectionString>(ravenDBConStr);
PutConnectionStringResult connectionStringResult = store.Maintenance.Send(PutConnectionStringOp);

Syntax:

public class RavenConnectionString : ConnectionString
{
    public override ConnectionStringType Type => ConnectionStringType.Raven;
    
    public string Database { get; set; }   // Target database name
    public string[] TopologyDiscoveryUrls; // List of server urls in the target RavenDB cluster
}

SQL connection strings are used by RavenDB SQL ETL Tasks.

Example:

// Define a connection string to a SQL database destination
// ========================================================
var sqlConStr = new SqlConnectionString
{
    Name = "sql-connection-string-name",

    // Define destination factory name
    FactoryName = "MySql.Data.MySqlClient",

    // Define the destination database
    // May also need to define authentication and encryption parameters
    // By default, encrypted databases are sent over encrypted channels
    ConnectionString = "host=127.0.0.1;user=root;database=Northwind"
};

// Deploy (send) the connection string to the server via the PutConnectionStringOperation
// ======================================================================================
var PutConnectionStringOp = new PutConnectionStringOperation<SqlConnectionString>(sqlConStr);
PutConnectionStringResult connectionStringResult = store.Maintenance.Send(PutConnectionStringOp);

Syntax:

public class SqlConnectionString : ConnectionString
{
    public override ConnectionStringType Type => ConnectionStringType.Sql;
    
    public string ConnectionString { get; set; }
    public string FactoryName { get; set; }
}

Snowflake connection strings are used by RavenDB Snowflake ETL Tasks.

Example:

// Define a connection string to a Snowflake warehouse database
// ==========================================================
var SnowflakeConStr = new SnowflakeConnectionString
{
    Name = "snowflake-connection-string-name",
    ConnectionString = "ACCOUNT = " + SnowflakeAccount + "; USER = " + SnowflakeUser + "; PASSWORD = " + SnowflakePassword
};

// Deploy (send) the connection string to the server via the PutConnectionStringOperation
// ======================================================================================
var PutConnectionStringOp =
    new PutConnectionStringOperation<SnowflakeConnectionString>(SnowflakeConStr);
PutConnectionStringResult connectionStringResult = store.Maintenance.Send(PutConnectionStringOp);

OLAP connection strings are used by RavenDB OLAP ETL Tasks.

Example: To a local machine

// Define a connection string to a local OLAP destination
// ======================================================
OlapConnectionString olapConStr = new OlapConnectionString
{
    Name = "olap-connection-string-name",
    LocalSettings = new LocalSettings
    {
        FolderPath = "path-to-local-folder"
    }
};

// Deploy (send) the connection string to the server via the PutConnectionStringOperation
// ======================================================================================
var PutConnectionStringOp = new PutConnectionStringOperation<OlapConnectionString>(olapConStr);
PutConnectionStringResult connectionStringResult = store.Maintenance.Send(PutConnectionStringOp);

Example: To a cloud-based server

• The following example shows a connection string to Amazon AWS.
• Adjust the parameters as needed if you are using other cloud-based servers (e.g. Google, Azure, Glacier, S3, FTP).
• The available parameters are listed in ETL destination settings.

// Define a connection string to an AWS OLAP destination
// =====================================================
var olapConStr = new OlapConnectionString
{
    Name = "myOlapConnectionStringName",
    S3Settings = new S3Settings
    {
        BucketName = "myBucket",
        RemoteFolderName = "my/folder/name",
        AwsAccessKey = "myAccessKey",
        AwsSecretKey = "myPassword",
        AwsRegionName = "us-east-1"
    }
};

// Deploy (send) the connection string to the server via the PutConnectionStringOperation
// ======================================================================================
var PutConnectionStringOp = new PutConnectionStringOperation<OlapConnectionString>(olapConStr);
PutConnectionStringResult connectionStringResult = store.Maintenance.Send(PutConnectionStringOp);

Syntax:

public class OlapConnectionString : ConnectionString
{
    public override ConnectionStringType Type => ConnectionStringType.Olap;
    
    public LocalSettings LocalSettings { get; set; }
    public S3Settings S3Settings { get; set; }
    public AzureSettings AzureSettings { get; set; }
    public GlacierSettings GlacierSettings { get; set; }
    public GoogleCloudSettings GoogleCloudSettings { get; set; }
    public FtpSettings FtpSettings { get; set; }
}

Elasticsearch connection strings are used by RavenDB Elasticsearch ETL Tasks.

Example:

// Define a connection string to an Elasticsearch destination
// ==========================================================
var elasticSearchConStr = new ElasticSearchConnectionString
{
    Name = "elasticsearch-connection-string-name",
    
    // Elasticsearch Nodes URLs
    Nodes = new[] { "http://localhost:9200" },
    
    // Authentication Method
    Authentication = new Raven.Client.Documents.Operations.ETL.ElasticSearch.Authentication
    {
        Basic = new BasicAuthentication
        {
            Username = "John",
            Password = "32n4j5kp8"
        }
    }
};

// Deploy (send) the connection string to the server via the PutConnectionStringOperation
// ======================================================================================
var PutConnectionStringOp = 
    new PutConnectionStringOperation<ElasticSearchConnectionString>(elasticSearchConStr);
PutConnectionStringResult connectionStringResult = store.Maintenance.Send(PutConnectionStringOp);

Syntax:

public class ElasticsearchConnectionString : ConnectionString
{
    public override ConnectionStringType Type => ConnectionStringType.ElasticSearch;
    
    public string Nodes { get; set; }
    public string Authentication { get; set; }
    public string Basic { get; set; }
    public string Username { get; set; }
    public string Password { get; set; }
}

Kafkah connection strings are used by RavenDB Kafka Queue ETL Tasks.
Learn how to add a Kafka connection string in the Add a Kafka connection string section.

RabbitMQ connection strings are used by RavenDB RabbitMQ Queue ETL Tasks.
Learn how to add a RabbitMQ connection string in the Add a RabbitMQ connection string section.

Azure Queue Storage connection strings are used by RavenDB Azure Queue Storage ETL Tasks.
Learn to add an Azure Queue Storage connection string in the Add an Azure Queue Storage connection string section.

Amazon SQS connection strings are used by RavenDB Amazon SQS ETL Tasks.
Learn to add an SQS connection string in this section.

public PutConnectionStringOperation(T connectionString)

// All the connection string class types inherit from this abstract ConnectionString class:
// ========================================================================================

public abstract class ConnectionString
{
    // A name for the connection string
    public string Name { get; set; }
    
    // The connection string type
    public abstract ConnectionStringType Type { get; } 
}

public enum ConnectionStringType
{
    RavenNone,
    Raven,
    Sql,
    Olap,
    ElasticSearch,
    Queue,
    Snowflake
}