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.

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

Move DBItest specification to DBI #129

Closed
krlmlr opened this issue Aug 1, 2016 · 4 comments
Closed

Move DBItest specification to DBI #129

krlmlr opened this issue Aug 1, 2016 · 4 comments
Milestone

Comments

@krlmlr
Copy link
Member

krlmlr commented Aug 1, 2016

I feel that the prose for the DBI specification is best suited in this package, because it is actually useful for DBI users. The prose is tightly connected to the specification code, but isolated from the actual testing logic, which can stay in DBItest for now.

One minor obstacle is that we don't want to introduce import dependencies, but the spec code requires testthat. We could make retrieving the actual spec code conditional on the presence of the testthat package.

@hadley: Do you have a strong opinion here?

@hadley
Copy link
Member

hadley commented Aug 1, 2016

Just that the prose explanations need to stay in this package.

@krlmlr
Copy link
Member Author

krlmlr commented Aug 1, 2016

"this package" = DBI?

@hadley
Copy link
Member

hadley commented Aug 1, 2016

Yes

@krlmlr krlmlr modified the milestones: 0.6, 0.5 Aug 2, 2016
@krlmlr
Copy link
Member Author

krlmlr commented Aug 6, 2016

Moving the definition of the DBI specs from DBItest to DBI looks too difficult, but DBI will contain a copy of the prose.

krlmlr pushed a commit to r-dbi/DBItest that referenced this issue Aug 6, 2016
- Add machinery to automatically copy `DBIspec.Rd` to a local checkout of the DBI package (r-dbi/DBI#129).
- Get rid of "Format" and "Usage" sections in the specs.
krlmlr pushed a commit to r-dbi/DBItest that referenced this issue Aug 6, 2016
- Add machinery to automatically copy `DBIspec.Rd` to a local checkout of the DBI package (r-dbi/DBI#129), with message indicating if documentation was updated. Two passes may be necessary to arrive to a stable state.
- Get rid of "Format" and "Usage" sections, and aliases, in the specs.
@krlmlr krlmlr closed this as completed in f4284ff Aug 6, 2016
krlmlr pushed a commit that referenced this issue Aug 6, 2016
- HTML documentation generated by `staticdocs` is now uploaded to http://rstats-db.github.io/DBI for each build of the "production" branch (#131). For technical reasons, the DBI specification is not yet included there.
- New help topic "DBIspec" that contains the full DBI specification (currently work in progress) (#129).
- Improve documentation of generics by adding links to the class and related generics in the "See also" section under "Other DBI... generics" (#130).
- Revdep check.
krlmlr added a commit that referenced this issue Aug 11, 2016
- Interface changes
    - `dbDataType()` maps `character` values to `"TEXT"` by default (#102).
    - The default implementation of `dbQuoteString()` doesn't call `encodeString()` anymore: Neither SQLite nor Postgres understand e.g. `\n` in a string literal, and all of SQLite, Postgres, and MySQL accept an embedded newline (#121).

- Interface enhancements
    - New `dbSendStatement()` generic, forwards to `dbSendQuery()` by default (#20, #132).
    - New `dbExecute()`, calls `dbSendStatement()` by default (#109, @bborgesr).
    - New `dbWithTransaction()` that calls `dbBegin()` and `dbCommit()`, and `dbRollback()` on failure (#110, @bborgesr).
    - New `dbBreak()` function which allows aborting from within `dbWithTransaction()` (#115, #133).
    - Export `dbFetch()` and `dbQuoteString()` methods.

- Documentation improvements:
    - One example per function (except functions scheduled for deprecation) (#67).
    - Consistent layout and identifier naming.
    - Better documentation of generics by adding links to the class and related generics in the "See also" section under "Other DBI... generics" (#130). S4 documentation is directed to a hidden page to unclutter documentation index (#59).
    - Fix two minor vignette typos (#124, @mdsumner).
    - Add package documentation.
    - Remove misleading parts in `dbConnect()` documentation (#118).
    - Remove misleading link in `dbDataType()` documentation.
    - Remove full stop from documentation titles.
    - New help topic "DBIspec" that contains the full DBI specification (currently work in progress) (#129).
    - HTML documentation generated by `staticdocs` is now uploaded to http://rstats-db.github.io/DBI for each build of the "production" branch (#131).
    - Further minor changes and fixes.

- Internal
    - Use `contains` argument instead of `representation()` to denote base classes (#93).
    - Remove redundant declaration of transaction methods (#110, @bborgesr).
krlmlr added a commit that referenced this issue Jan 31, 2017
- Added specification from DBItest to methods documentation. Affected methods: `dbConnect()`, `dbDisconnect()`, `dbDataType()`, `dbSendQuery()`, `dbFetch()`, `dbClearResult()`, `dbGetQuery()`, `dbSendStatement()`, `dbExecute()`, `dbQuoteIdentifier()`, `dbQuoteString()`, `dbReadTable()`, `dbWriteTable()`, `dbRemoveTable()`, `dbExistsTable()`, and `dbListTables()` (#129).
- Added default implementation for `dbReadTable()`.
- Removed `dbQuoteIdentifier(DBIConnection, list)` again.
- Improved default implementation of `dbQuoteString()` and `dbQuoteIdentifier()` (#77).
- Removed `tryCatch()` call in `dbGetQuery()` (#113).
krlmlr added a commit that referenced this issue Jan 31, 2017
- Revert `...` hack for `sqlInterpolate()` and `sqlParseVariables()`, simply renamed arguments (#147).
- Added specification from DBItest to methods documentation. Affected methods: `dbConnect()`, `dbDisconnect()`, `dbDataType()`, `dbSendQuery()`, `dbFetch()`, `dbClearResult()`, `dbGetQuery()`, `dbSendStatement()`, `dbExecute()`, `dbQuoteIdentifier()`, `dbQuoteString()`, `dbReadTable()`, `dbWriteTable()`, `dbRemoveTable()`, `dbExistsTable()`, and `dbListTables()` (#129).
- Added default implementation for `dbReadTable()`.
- Removed `dbQuoteIdentifier(DBIConnection, list)` again.
- Improved default implementation of `dbQuoteString()` and `dbQuoteIdentifier()` (#77).
- Removed `tryCatch()` call in `dbGetQuery()` (#113).
@github-actions github-actions bot locked and limited conversation to collaborators Oct 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants