simple query documentation

Updated Client (markdown)
brianc 2010-11-01 11:02:37 -07:00
parent f5da6b67d4
commit 2bb459577a

@ -2,10 +2,10 @@ Basically a facade on top of the connection to provide a _much_ more user friend
## Constructor
---
### new Client(_object_ config) : _Client_
Creates a new instance of a Client configured via supplied configuration object. In normal instantiation the client will _not_ be connected automatically.
##### parameters
- __config__: [_object_] can contain any of the following optional properties
@ -42,15 +42,38 @@ Creates a new instance of a Client configured via supplied configuration object.
port: 5313
});
```
## Methods
---
### connect() : _null_
Initializes underlying net.Stream() and startup communication with PostgreSQL server. Once the connection is finished, the __Client__ emits the _connect_ event.
### end() : _null_
Immediately sends a termination message to the PostgreSQL server and closes the underlying net.Stream().
### query(_string_ text) : _[[Query]]_
Simply: Executes a simple, parameterless text query and returns rows.
In more detail: Adds a __[[Query]]__ to the __Client__'s internal [[query queue|QueryQueue]]. The query is executed as a simple query within PostgresSQL, takes no parameters, and it is parsed, bound, executed, and all rows are streamed backed to the __Client__ in one step within the PostgreSQL server. For more detailed information [you can read the PostgreSQL protocol documentation](http://developer.postgresql.org/pgdocs/postgres/protocol-flow.html#AEN87085).
##### parameters
- __text__: [_string_] the query text
##### example
```javascript
var client = new Client({user: 'brianc', database: 'test'});
client.connect();
//query is executed once connection is established and
//PostgreSQL server is ready for a query
var query = client.query("select name from user")
query.on('row', function(row) {
console.log(row.fields[0]);
});
query.on('end', client.end.bind(client));
```
### query(_object_ config) : _[[Query]]_