This repository was archived by the owner on Jan 28, 2021. It is now read-only.
Improve README #207
Merged
Improve README #207
Conversation
This file contains hidden or 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
Signed-off-by: Antonio Jesus Navarro Perez <antnavper@gmail.com>
erizocosmico
suggested changes
Jun 6, 2018
README.md
Outdated
| `go-mysql-server` has a sql engine and a server implementation, so to start a server you must instantiate the engine and give it your `sql.Database` implementation that will be in charge to handle all the logic about retrieving the data from your source : | ||
| `go-mysql-server` has a sql engine and a server implementation, | ||
| so to start a server you must instantiate the engine and give it your `sql.Database` implementation. | ||
| It will be in charge to handle all the logic about retrieving the data from your source. |
There was a problem hiding this comment.
s/to handle/of handling/
There was a problem hiding this comment.
s/about retrieving/for retrieving/
There was a problem hiding this comment.
or maybe "...to retrieve the data from your source"
README.md
Outdated
| To be able to create your own data source implementation you need to implement the following interfaces: | ||
|
|
||
| - `sql.Database` interface. This interface will provide tables from your data source. | ||
| - If your database implementation supports add more tables, you might want to add support to `sql.Alterable` interface |
There was a problem hiding this comment.
s/supports add more tables/supports adding more tables/
s/add support to/add support for/
README.md
Outdated
| - `sql.Database` interface. This interface will provide tables from your data source. | ||
| - If your database implementation supports add more tables, you might want to add support to `sql.Alterable` interface | ||
|
|
||
| - `sql.Table` interface. It will be in charge to transform any kind of data to an iterator of Rows. Depending of how much you want to optimize the queries, you also can implement other interfaces on your tables: |
There was a problem hiding this comment.
s/to transform/of transforming/
s/to an iterator/into an iterator/
README.md
Outdated
| - If your database implementation supports add more tables, you might want to add support to `sql.Alterable` interface | ||
|
|
||
| - `sql.Table` interface. It will be in charge to transform any kind of data to an iterator of Rows. Depending of how much you want to optimize the queries, you also can implement other interfaces on your tables: | ||
| - `sql.PushdownProjectionTable` interface will provides you a way to get only the columns needed for the executed query. |
There was a problem hiding this comment.
s/will provides/will provide/
README.md
Outdated
|
|
||
| - `sql.Table` interface. It will be in charge to transform any kind of data to an iterator of Rows. Depending of how much you want to optimize the queries, you also can implement other interfaces on your tables: | ||
| - `sql.PushdownProjectionTable` interface will provides you a way to get only the columns needed for the executed query. | ||
| - `sql.PushdownProjectionAndFiltersTable` interface will provide the same functionality described before, but also will push down the filters used in the executed query. Doing this, it allows you to filter before hand data, and improve query speed. |
There was a problem hiding this comment.
s/it allows you to/you can/
s/before hand data/data beforehand/
s/query speed/the query speed/
There was a problem hiding this comment.
Maybe:
It allows to filter a data in advance, and speed up query
README.md
Outdated
| - `sql.Table` interface. It will be in charge to transform any kind of data to an iterator of Rows. Depending of how much you want to optimize the queries, you also can implement other interfaces on your tables: | ||
| - `sql.PushdownProjectionTable` interface will provides you a way to get only the columns needed for the executed query. | ||
| - `sql.PushdownProjectionAndFiltersTable` interface will provide the same functionality described before, but also will push down the filters used in the executed query. Doing this, it allows you to filter before hand data, and improve query speed. | ||
| - `sql.Indexable` add index capabilities to your table. Implementing this interface you can create and use indexes on this tables. |
There was a problem hiding this comment.
s/Implementing this/By implementing this/
s/on this tables/on this table/
README.md
Outdated
| - `sql.PushdownProjectionTable` interface will provides you a way to get only the columns needed for the executed query. | ||
| - `sql.PushdownProjectionAndFiltersTable` interface will provide the same functionality described before, but also will push down the filters used in the executed query. Doing this, it allows you to filter before hand data, and improve query speed. | ||
| - `sql.Indexable` add index capabilities to your table. Implementing this interface you can create and use indexes on this tables. | ||
| - `sql.Inserter` can be implemented if your data source tables allows insertions. |
kuba--
approved these changes
Jun 6, 2018
README.md
Outdated
|
|
||
| ## Example | ||
|
|
||
| `go-mysql-server` has a sql engine and a server implementation, so to start a server you must instantiate the engine and give it your `sql.Database` implementation that will be in charge to handle all the logic about retrieving the data from your source : | ||
| `go-mysql-server` has a sql engine and a server implementation, |
There was a problem hiding this comment.
I would write sth. like:
...contains a sql engine and server implementation. So, if you want to start a server, first instantiate the engine and pass your sql.Database implementation.
jfontan
approved these changes
Jun 6, 2018
Signed-off-by: Antonio Jesus Navarro Perez <antnavper@gmail.com>
|
@erizocosmico done. |
erizocosmico
approved these changes
Jun 7, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: Antonio Jesus Navarro Perez antnavper@gmail.com