Promises are made to be kept! HiveSQL's proposal mentioned the creation of documentation and tutorials. Here is finally the culmination of a long work that I undertook several weeks ago: the HiveSQL documentation.
After many tests with different documentation solutions, my choice finally fell on gitbooks which, in my opinion, offer a lot of flexibility, both in terms of content editing and maintenance.
TL;DR: HiveSQL documentation can be found at https://docs.hivesql.io
What's in it?
First, there is general information on
- what is HiveSQL.
- how to access it.
- how to get support.
Things that current HiveSQL users are already used to.
You will then find more technical information such as:
- a database diagram
- an exhaustive list of all available tables
- a description for each table's column
Yes, you read it well: for all operations, virtual operations and state tables, each column of each table is described. This should interest many developers, even if they do not use Hiveql.
The documentation describes:
- Operations
- Virtual Operations
- State tables like Accounts and Comments
It also describes how to use HiveSQL exclusive features like Full-Text Search and Language Detection.
The documentation also contains various tutorials for developers, notably PHP, Python, Ruby and even for Microsoft Excel users. More to come.
Other Resources
I also searched the blockchain to find the various posts that have been written about HiveSQL. So I grouped the links to these different posts on a resource page to make it easier for you to find them.
If you have made a post that deserves to appear there, do not hesitate to contact me as well.
What's next?
There is still room to improve this documentation. I am thinking about examples of complex queries, more detailed information on the blockchain content and operations.
Some of the tutorials provided are quite rudimentary. I plan to improve them too. Do not hesitate to contact me if you want to add your contribution.
But I first wish to have your feedback on its current state before going further.
Feel free to use the HiveSQL Discord channel to report typos or make suggestions.
One last word
Thank you to @inertia for the amazing work he did with the Hive Developer Documentation from which I borrowed a few sentences.
I truly believe that both documentations are complementary resources and that they will help everyone, developers and non-developers, to understand the content and organization of our blockchain.
The HiveSQL Documentation is available at https://docs.hivesql.io
Support our proposals
| HiveSQL (to keep it free for all) | HiveBuzz (to keep it entertaining) |
|---|---|
| Vote for the proposal on PeakD Vote for the proposal on Ecency Vote for the proposal using HiveSigner | Vote for the proposal on PeakD Vote for the proposal on Ecency Vote for the proposal using HiveSigner |
Check out my apps and services
This is great. I need to explore what other data I can extract. Linking to some tutorials will help. If people publish their queries we can adapt them to our needs.
Thanks
!BEER
UPDATE: I just saw you linked to a couple of my posts :)
Feel free to ask me if you need any help regarding tables or data . I will try to point you in the right direction since I have been using HiveSQL data for a while now .
Posted Using LeoFinance Beta
Cheers. I've done a few queries, so I know the basics. I really think it's good to post useful queries.
!ENGAGE 15
I agree , I usually work with python though but I might be able to do couple of posts related to that . Let me check :)
Posted Using LeoFinance Beta
I work with Python too. A couple of my posts are linked from here
ENGAGEtoday.Thank you @steevc
!BEER !LUV
Hi @steevc, you were just shared some LUV thanks to @arcange. Holding at least 10 LUV in your wallet enables you to give up to 3 LUV per day, for free. See the LUV in your wallet at https://hive-engine.com or learn about LUV at https://peakd.com/@luvshares https://ipfs.io/ipfs/QmUptF5k64xBvsQ9B6MjZo1dc2JwvXTWjWJAnyMCtWZxqM
Will people read the documentation more than the posts on the Hive blockchain? I ask this, because nowadays most people are using automated curation, and they do not even see the posts they curate.
Those for whom the documentation may be useful will probably read it. That's what matters to me.
Both of them aren't really related .
These docs are mainly for developers as well as data analysts like myself . Most of the projects heavily depend on HiveSQL for data .
Posted Using LeoFinance Beta
Those who use it will read it. Automated curation is a different problem.
Thanks my friend. Your posts are always informative and helpful. Upvoted and rehived
Thank you @thethreehugs
You are most welcome.
Great to see an excel tutorial. I will try playing with it as I don't have a programming background.
I got a question. What username & password should be used to log in? is it my username and posting key? or anything specific to database and I have to create a user profile first?
You should use your HiveSQL credentials. I updated the tutorial
That's great. Thanks:)
Is there an excel tutorial how to get selected data?
As I logged in and selected accounts, it's loading all accounts.
Thanks :)
This is not Excel stuff. The worst thing to do is to retrieve all data and filter it at the Excel level.
You should learn how to write SQL queries to narrow the scope of data returned.
There is such an example in the tutorial.
Ok. I will read some stuff and look in youtube. Thanks for help.
❤️ Nice work
Thank you @repayme4568
Congratulations @arcange! You have completed the following achievement on the Hive blockchain and have been rewarded with new badge(s) :
Your next target is to reach 490000 upvotes.
You can view your badges on your board and compare yourself to others in the Ranking
If you no longer want to receive notifications, reply to this comment with the word
STOPSupport the HiveBuzz project. Vote for our proposal!
How exciting!
Amazing , till now I mostly went through all the tables and all the columns within it to see what data it has but now I can use this :)
Posted Using LeoFinance Beta
I hope to be able to read it, and learn and try to do some simple automation task to get info I want to look at.
Excellent . Its very helpful. Good work.
Thank you @marian0
Thanks arcange!
I really appreciate about your effort, data is important think. Honestly I don't know much about programming but I believe di SQL over Hive blockchain is really important.
Thank you @happyphoenix
Hi @arcange, thank you for putting together the documentation. I have a few questions and thought I'd put them here so everyone on the blockchain can benefit from the info.
The VOSPSFunds table looks like it is tracking how much funds are going into the DHF from inflation (it's supposed to be 10% of inflation, I think). Is that right? And if so, is the blockchain converting the new Hive from inflation into HBD before adding it to the DHF (since I see in VOSPSFunds that only HBD is being added)? The amount of HBD added to the DHF each hour varies - would that be because of price fluctuations in Hive and varying levels of posting on the blockchain (and therefore varying total inflation going to curation rewards)?
In the VOAuthorRewards table, the vesting_payout column looks like it shows the amount of VESTS paid out, rather than HP - is that right? The column description initially led me to think the amount was in HP.