Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Warning for custom typeCast callbacks #541

Merged
merged 2 commits into from
Jul 12, 2013
Merged

Warning for custom typeCast callbacks #541

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a07b22
Warn user about doom and gloom surrounding custom typecasting
tomasikp Jul 11, 2013
e76dc97
Update Readme.md
tomasikp Jul 11, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,9 +850,21 @@ connection.query({
}
});
```
__WARNING: YOU MUST INVOKE the parser using one of these three field functions in your custom typeCast callback. They can only be called once.( see #539 for discussion)__

```
field.string()
field.buffer()
field.geometry()
```
are aliases for
```
parser.parseLengthCodedString()
parser.parseLengthCodedBuffer()
parser.parseGeometryValue()
```
__You can find which field function you need to use by looking at: [RowDataPacket.prototype._typeCast](https://github.com/felixge/node-mysql/blob/master/lib/protocol/packets/RowDataPacket.js#L41)__

If you need a buffer there's also a `.buffer()` function and also a `.geometry()` one
both used by the default type cast that you can use.

## Connection Flags

Expand Down