Skip to content

Commit

Permalink
Merge pull request #179 from keboola/deprecate-indexed-columns
Browse files Browse the repository at this point in the history
Deprecate indexed columns
  • Loading branch information
Halama authored Feb 7, 2018
2 parents df8c114 + d224f5c commit 8b6c523
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
9 changes: 7 additions & 2 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -1228,8 +1228,7 @@ Exported rows can be filtered by a single filter. Examples of filtering by `user
- `whereColumn=UserId&whereValues[]=23423&whereValues[]=123` - Filters by multiple values of one column.
- `whereColumn=UserId&whereValues[]=23423&whereOperator=ne` - Uses a different comparison operator.

Only [Indexed columns](#reference/tables/create-column-index/mark-column-as-indexed) can be used in the `whereColumn` parameter.
The comparison operator essentially behaves like the [SQL IN](http://www.w3schools.com/sql/sql_in.asp) (and NOT IN) operator. That is, the
The comparison operator essentially behaves like the [SQL IN](http://www.w3schools.com/sql/sql_in.asp) (and NOT IN) operator. That is, the
`eq` value matches if any `whereValues` match, and the `new` value matches if none `whereValues` match.

#### Caching
Expand Down Expand Up @@ -1681,6 +1680,9 @@ Removes the primary key from a table. This request is [asynchronous](#introducti
## Create Column Index [/v2/storage/buckets/{table_id}/indexed-columns/]

### Mark column as indexed [POST]

** Indexed columns are deprecated and no longer required, filtering is now allowed on all table columns.**

Indexed columns can be used to filter data when [exporting](#reference/tables/unload-data-asynchronously/asynchronous-export).
Columns in a primary key are automatically indexed. The number of indexed columns is limited to 4 including the primary key.
This request is [asynchronous](#introduction/synchronous-and-asynchronous-calls).
Expand Down Expand Up @@ -1723,6 +1725,9 @@ This request is [asynchronous](#introduction/synchronous-and-asynchronous-calls)
## Manage Column Indexes [/v2/storage/tables/{table_id}/indexed-columns/{column_name}]

### Remove Column Index [DELETE]

** Indexed columns are deprecated and no longer required, filtering is now allowed on all table columns.**

Removes a column from an index. This request is [asynchronous](#introduction/synchronous-and-asynchronous-calls).

+ Parameters
Expand Down
8 changes: 2 additions & 6 deletions src/Keboola/StorageApi/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -894,9 +894,7 @@ public function deleteTableColumn($tableId, $name)
}

/**
*
* Add column to table
*
* @deprecated Indexed columns are no longer required for filtering and will be removed soon
* @param string $tableId
* @param string $columnName
*/
Expand All @@ -910,9 +908,7 @@ public function markTableColumnAsIndexed($tableId, $columnName)


/**
*
* Delete a table attribute
*
* @deprecated Indexed columns are no longer required for filtering and will be removed soon
* @param string $tableId
* @param string $columnName
* @return mixed|string
Expand Down

0 comments on commit 8b6c523

Please sign in to comment.