jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2016-10-11 13:52:18 UTC

Browse source
This commit is contained in:
Travis CI 2016-10-11 13:52:18 +00:00
parent 734e0963e0
commit 6946fc9fd0
25 changed files with 375 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

331
topics/database/index.html Normal file
View file

@ -0,0 +1,331 @@
<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Home Assistant Database - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Details about the database which Home Assistant is using.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/topics/database/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Home Assistant Database">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/topics/database/">
<meta property="og:type" content="article">
<meta property="og:description" content="Details about the database which Home Assistant is using.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Home Assistant Database">
<meta name="twitter:description" content="Details about the database which Home Assistant is using.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook/'>Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_topics/database.markdown'>Edit this page on GitHub</a></div>
<header>
<h1 class="title indent">
Home Assistant Database
</h1>
</header>
<hr class="divider">
<p>The default database that is used for Home Assistant is <a href="https://www.sqlite.org/">SQLite</a> and is stored in your <a href="/getting-started/configuration/">configuration directory</a>, eg. <code class="highlighter-rouge">&lt;path to config dir&gt;/.homeassistant/home-assistant_v2.db</code>. You will need an installation of <code class="highlighter-rouge">sqlite3</code>, the command-line for SQLite database, or <a href="http://sqlitebrowser.org/">DB Browser for SQLite</a> which provide an editor for executing SQL commands.
First load your database with <code class="highlighter-rouge">sqlite3</code>.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sqlite3 home-assistant_v2.db
SQLite version 3.13.0 2016-05-18 10:57:30
Enter <span class="s2">".help"</span> <span class="k">for </span>usage hints.
<span class="gp">sqlite&gt; </span>
</code></pre>
</div>
<p>It helps to set some options to make the output better readable.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>.header on
<span class="gp">sqlite&gt; </span>.mode column
</code></pre>
</div>
<p>You could also start <code class="highlighter-rouge">sqlite3</code> and attach the database later. Not sure what database you are working with? Check it, especially if you are going to delete data.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>.databases
seq name file
--- --------------- ----------------------------------------------------------
0 main /home/fab/.homeassistant/home-assistant_v2.db
</code></pre>
</div>
<h3><a class="title-link" name="schema" href="#schema"></a> Schema</h3>
<p>Get all available tables from your current Home Assistant database.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>SELECT sql FROM sqlite_master;
-------------------------------------------------------------------------------------
CREATE TABLE events <span class="o">(</span>
event_id INTEGER NOT NULL,
event_type VARCHAR<span class="o">(</span>32<span class="o">)</span>,
event_data TEXT,
origin VARCHAR<span class="o">(</span>32<span class="o">)</span>,
time_fired DATETIME,
created DATETIME,
PRIMARY KEY <span class="o">(</span>event_id<span class="o">)</span>
<span class="o">)</span>
CREATE INDEX ix_events_event_type ON events <span class="o">(</span>event_type<span class="o">)</span>
CREATE TABLE recorder_runs <span class="o">(</span>
run_id INTEGER NOT NULL,
start DATETIME,
<span class="s2">"end"</span> DATETIME,
closed_incorrect BOOLEAN,
created DATETIME,
PRIMARY KEY <span class="o">(</span>run_id<span class="o">)</span>,
CHECK <span class="o">(</span>closed_incorrect IN <span class="o">(</span>0, 1<span class="o">))</span>
<span class="o">)</span>
CREATE TABLE states <span class="o">(</span>
state_id INTEGER NOT NULL,
domain VARCHAR<span class="o">(</span>64<span class="o">)</span>,
entity_id VARCHAR<span class="o">(</span>64<span class="o">)</span>,
state VARCHAR<span class="o">(</span>255<span class="o">)</span>,
attributes TEXT,
event_id INTEGER,
last_changed DATETIME,
last_updated DATETIME,
created DATETIME,
PRIMARY KEY <span class="o">(</span>state_id<span class="o">)</span>,
FOREIGN KEY<span class="o">(</span>event_id<span class="o">)</span> REFERENCES events <span class="o">(</span>event_id<span class="o">)</span>
<span class="o">)</span>
CREATE INDEX states__significant_changes ON states <span class="o">(</span>domain, last_updated, entity_id<span class="o">)</span>
CREATE INDEX states__state_changes ON states <span class="o">(</span>last_changed, last_updated, entity_id<span class="o">)</span>
CREATE TABLE sqlite_stat1<span class="o">(</span>tbl,idx,stat<span class="o">)</span>
</code></pre>
</div>
<p>To only show the details about the <code class="highlighter-rouge">states</code> table as we are using that one in the next examples.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>SELECT sql FROM sqlite_master WHERE <span class="nb">type</span> <span class="o">=</span> <span class="s1">'table'</span> AND tbl_name <span class="o">=</span> <span class="s1">'states'</span>;
</code></pre>
</div>
<h3><a class="title-link" name="query" href="#query"></a> Query</h3>
<p>The identification of the available columns in the table is done and we are now able to create a query. Let’s list of your Top 10 entities.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>.width 30, 10,
<span class="gp">sqlite&gt; </span>SELECT entity_id, COUNT<span class="o">(</span><span class="k">*</span><span class="o">)</span> as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10;
entity_id count
------------------------------ ----------
sensor.cpu 28874
sun.sun 21238
sensor.time 18415
sensor.new_york 18393
cover.kitchen_cover 17811
switch.mystrom_switch 14101
sensor.internet_time 12963
sensor.solar_angle1 11397
sensor.solar_angle 10440
group.all_switches 8018
</code></pre>
</div>
<h3><a class="title-link" name="delete" href="#delete"></a> Delete</h3>
<p>If you don’t want to keep certain entities, you can delete them permanently.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>DELETE FROM states WHERE <span class="nv">entity_id</span><span class="o">=</span><span class="s2">"sensor.cpu"</span>;
</code></pre>
</div>
<p>The <code class="highlighter-rouge">VACUUM</code> command cleans the your database.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">sqlite&gt; </span>VACUUM;
</code></pre>
</div>
<p>For a more interactive way to work with the database or the create statistics, checkout our <a href="http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/">Jupyther notebooks</a>.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<h1 class="title delta">About Home Assistant</h1>
<ul class="divided">
<li>
Home Assistant is an open-source home automation platform running on Python 3. Track and control all devices at home and automate control.
</li>
<li><a href='/getting-started/'>Get started with Home Assistant</a></li>
<li><a href='/demo/'>Try the online demo</a></li>
<li><a class="twitter-follow-button" href="https://twitter.com/Home_Assistant">Follow Home Assistant on Twitter</a></li>
<li><div class="fb-like" data-href="https://www.facebook.com/homeassistantio/" data-layout="standard" data-action="like" data-size="small" data-show-faces="true" data-share="false"></div></li>
</ul>
</section>
<div id="fb-root"></div>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.async=true;js.src='//platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<script>(function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(d.getElementById(id)){return;}js=d.createElement(s);js.id=id;js.async=true;js.src="//connect.facebook.net/en_US/all.js#appId=338291289691179&xfbml=1";fjs.parentNode.insertBefore(js,fjs);}(document,'script','facebook-jssdk'));</script>
<section class="sharing aside-module grid__item one-whole lap-one-half">
<h1 class="title delta">Share this post</h1>
<a href="//twitter.com/share"
class="twitter-share-button"
data-via="home_assistant"
data-related="home_assistant"
data-url="https://home-assistant.io/topics/database/"
data-counturl="https://home-assistant.io/topics/database/" >Tweet</a>
<div class="fb-share-button" style='top: -6px;'
data-href="https://home-assistant.io/topics/database/"
data-layout="button_count">
</div>
<div class="g-plusone" data-size="standard"></div>
</section>
<script src="https://apis.google.com/js/platform.js" async defer></script>
<section id="recent-posts" class="aside-module grid__item one-whole lap-one-half">
<h1 class="title delta">Recent Posts</h1>
<ul class="divided">
<li class="post">
<a href="/blog/2016/10/08/hassbian-rest-digital-ocean/">0.30: More Async, HASSbian, Digital Ocean, statistics, REST</a>
</li>
<li class="post">
<a href="/blog/2016/10/02/hacktoberfest/">Participating in Hacktoberfest</a>
</li>
<li class="post">
<a href="/blog/2016/10/01/we-have-raspberry-image-now/">We have a Raspberry Pi image now</a>
</li>
<li class="post">
<a href="/blog/2016/09/29/async-sleepiq-emoncms-stocks/">0.29: 🎈 Async, SleepIQ, OpenALPR, EmonCMS, stocks, and plants</a>
</li>
<li class="post">
<a href="/blog/2016/09/10/notify-group-reload-api-pihole/">0.28: Reload automation and groups, API documentation, car tracking, Pi-Hole stats</a>
</li>
</ul>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>