open {mysql} | R Documentation

## open a mysql connection, construct a database model

### Description

### Usage

    open(
        user.name = NULL,
        password = NULL,
        dbname = NULL,
        host = "localhost",
        port = 3306,
        error.log = NULL,
        timeout = -1,
        connection.uri = NULL,
        general = FALSE,
        ssh = NULL);

### Arguments

user.name

  [as string]

password

  [as string]

dbname

  [as string]

host

  [as string]

port

  [as integer]

ssh

  ssh forward configuration, is a tuple list that has data fields: 1. user: ssh user name 2. password: ssh password 3. port: ssh server port, default is 22 4. local: ssh local port for forward the connection, default is 3307. [as list]

env

  [as Environment]

### Details

### Authors

graphR

### Value

this function returns data object of type IDatabase.

#### clr value class

- IDatabase

### Examples

[Package mysql version 1.0.0.0 Index]