Added ds_upsert function and extended default parameters in ds_search_sql #102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
blargh! sorry I must have seen the email for this, but forgot about it. taking a look now |
sckott
suggested changes
May 2, 2018
| #' @template key | ||
| #' @template args | ||
| #' @references \url{http://bit.ly/1G9cnBl} | ||
|
|
There was a problem hiding this comment.
please add some examples here
| #' against. | ||
| #' @param force (logical) Set to \code{TRUE} to edit a read-only resource. | ||
| #' Default: FALSE | ||
| #' @param method (string) Set to \code{insert}, \code{upsert} or \code{update} |
There was a problem hiding this comment.
can you add either here or in @details or @section what these different options are for the method param
| #' Default: FALSE | ||
| #' @param method (string) Set to \code{insert}, \code{upsert} or \code{update} | ||
| #' Default: 'upsert' | ||
| #' @param records (list) The data, eg: \code{[{"dob": "2005", "some_stuff": |
There was a problem hiding this comment.
the example data you give here is JSON. can you give an example that is R specific, or at least say what is allowed to be passed in. A data.frame? A list? Both? something else?
| @@ -13,9 +13,10 @@ | |||
| #' } | |||
| #' @importFrom httr status_code | |||
|
|
|||
| ds_search_sql <- function(sql, url = get_default_url(), as = 'list', ...) { | |||
| ds_search_sql <- function(sql, url = get_default_url(), as = 'list', | |||
| config = httr::add_headers(Authorization = get_default_key()), ...) { | |||
There was a problem hiding this comment.
why not just use key = get_default_key()? in the function definition, and then add_headers(Authorization = key) internally in the GET call
|
@jklanger any thoughts? |
added 2 commits
January 8, 2019 15:36
… the helper function 'tojun' to 'null' instead of NULL
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The added ds_upsert function uses the ckan-api-datastore_upsert to execute three different actions: upsert, update and insert. Form and description style of the ds_upsert function are heavily oriented on the ds_create function. To choose which action shall be executed a method parameter was added.
The small change in ds_search_sql simplifies the usage of authorization-keys and per default uses
the key provided by get_default_key. Before the config had to be added manually. With this default a authorization key set during setup will automatically be used for the query.
Example
ds_upsert(resource_id="db-key", records=data.frame(key1, key2, value), force=FALSE, method="upsert")