edbColnames.RODBC_MySQL: Retrieve column names of a table in a MySQL database...

Description Usage Arguments Value Author(s) See Also Examples

Description

Retrieve column names of a table in a MySQL database

(referenced by 'edb'). Wrapper around RODBC::sqlColumns().

Notice that the method does NOT retrieve the full table to

get its column names (so it should work even if the table is big).

Usage

1
2
3
4
5
## S3 method for class 'RODBC_MySQL'
edbColnames(edb, tableName, onlyNames = TRUE, 


    ...)

Arguments

edb

An object of class 'edb', such as returned by edb.

tableName

Single character string. Name of the table to read in 'edb'.

onlyNames

Single logical. If TRUE only returns the column names (vector),

and if FALSE returns a detailed table as in

sqlColumns.

...

Additional parameters to be passed to dbListFields(). See

?dbListFields.

Value

The function returns a vector of character strings with the

columns / fields of the original MySQL table, or a table with

full details on the columns (see onlyNames).

Author(s)

Julien MOEYS <Julien.Moeys@mark.slu.se>

See Also

edb, edbRead.RODBC_MySQL,

edbWrite.RODBC_MySQL,

edbNames.RODBC_MySQL.

Examples

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
library( "easyrodbcmysql" ) 











testMySQL <- FALSE # Set to TRUE to run some tests


                   # after modifying the edb() part below 


                   # with your own database setting











### Windows only:


if( (Sys.info()[[ "sysname" ]] == "Windows") & testMySQL ){ 


    


    ### Describe the database (NB: this is not a connection)


    myDb <- edb( 


        dbType       = "RODBC_MySQL", 


        dbSourceName = "nameOfODBCSource", # or any name you like


        dbName       = "nameOfDatabase", 


        dbLogin      = "yourUserName", 


        dbPwd        = "yourPassword", 


        dbHost       = "127.0.0.1", 


        dbPort       = 3306 


    )   #    


    


    


    


    ### Register the data source in ODBC 


    edbDataSource( myDb, verbose = TRUE ) 


    


    


    


    ### Use the database:


    


    # List the column names in a table:


    edbColnames( edb = myDb, tableName = "WRB_SOIL_GROUP" ) 


    


    # More details:


    edbColnames( 


        edb       = myDb, 


        tableName = "WRB_SOIL_GROUP", 


        onlyNames = FALSE # different too!


    )   #


    


    


    


    ### Un-register the data source in ODBC (windows only)


    edbDataSource( myDb, trash = TRUE ) 


}   #

easyrodbcmysql documentation built on May 2, 2019, 5:51 p.m.