Skip to content

Commit

Permalink
Deployed by Serverpod docs deploy action
Browse files Browse the repository at this point in the history
  • Loading branch information
serverpod_docs committed Dec 13, 2024
1 parent b0df635 commit 8f51d2e
Show file tree
Hide file tree
Showing 649 changed files with 748 additions and 747 deletions.
2 changes: 1 addition & 1 deletion docs/0.9.10.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.6.3">
<title data-rh="true">Get started | Serverpod</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://serverpod.github.io/0.9.10"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="0.9.10"><meta data-rh="true" name="docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" name="docsearch:version" content="0.9.10"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" property="og:title" content="Get started | Serverpod"><meta data-rh="true" name="description" content="Serverpod is an open-source, scalable app server, written in Dart for the Flutter community. Serverpod automatically generates your protocol and client-side code by analyzing your server. Calling a remote endpoint is as easy as making a local method call."><meta data-rh="true" property="og:description" content="Serverpod is an open-source, scalable app server, written in Dart for the Flutter community. Serverpod automatically generates your protocol and client-side code by analyzing your server. Calling a remote endpoint is as easy as making a local method call."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://serverpod.github.io/0.9.10"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10" hreflang="en"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10" hreflang="x-default"><script src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9ae02024-c2cf-4f58-b2d9-7ca3961dc1ef" data-project-name="Serverpod" data-project-color="#020F24" data-project-logo="https://avatars.githubusercontent.com/u/48181558?s=200&amp;v=4" async></script><link rel="stylesheet" href="/assets/css/styles.c77738bc.css">
<script src="/assets/js/runtime~main.616faf18.js" defer="defer"></script>
<script src="/assets/js/runtime~main.067cee69.js" defer="defer"></script>
<script src="/assets/js/main.41d55010.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
2 changes: 1 addition & 1 deletion docs/0.9.10/capabilities.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.6.3">
<title data-rh="true">Capabilities | Serverpod</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://serverpod.github.io/0.9.10/capabilities"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="0.9.10"><meta data-rh="true" name="docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" name="docsearch:version" content="0.9.10"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" property="og:title" content="Capabilities | Serverpod"><meta data-rh="true" name="description" content="Serverpod is a complete, competent backend for Flutter. For the glossy sales pitch, head over to our main page at Serverpod.dev."><meta data-rh="true" property="og:description" content="Serverpod is a complete, competent backend for Flutter. For the glossy sales pitch, head over to our main page at Serverpod.dev."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://serverpod.github.io/0.9.10/capabilities"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/capabilities" hreflang="en"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/capabilities" hreflang="x-default"><script src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9ae02024-c2cf-4f58-b2d9-7ca3961dc1ef" data-project-name="Serverpod" data-project-color="#020F24" data-project-logo="https://avatars.githubusercontent.com/u/48181558?s=200&amp;v=4" async></script><link rel="stylesheet" href="/assets/css/styles.c77738bc.css">
<script src="/assets/js/runtime~main.616faf18.js" defer="defer"></script>
<script src="/assets/js/runtime~main.067cee69.js" defer="defer"></script>
<script src="/assets/js/main.41d55010.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
2 changes: 1 addition & 1 deletion docs/0.9.10/concepts/authentication.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.6.3">
<title data-rh="true">Authentication | Serverpod</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://serverpod.github.io/0.9.10/concepts/authentication"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="0.9.10"><meta data-rh="true" name="docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" name="docsearch:version" content="0.9.10"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" property="og:title" content="Authentication | Serverpod"><meta data-rh="true" name="description" content="In Serverpod, authentication is managed through the serverpod_auth module. It makes it easy to authenticate users through email or 3rd parties. Currently supported is Signing in with email, Google, and Apple. Future versions of the authentication module will include more options. Using this module requires some setup with Google and Apple for things to work."><meta data-rh="true" property="og:description" content="In Serverpod, authentication is managed through the serverpod_auth module. It makes it easy to authenticate users through email or 3rd parties. Currently supported is Signing in with email, Google, and Apple. Future versions of the authentication module will include more options. Using this module requires some setup with Google and Apple for things to work."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://serverpod.github.io/0.9.10/concepts/authentication"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/concepts/authentication" hreflang="en"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/concepts/authentication" hreflang="x-default"><script src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9ae02024-c2cf-4f58-b2d9-7ca3961dc1ef" data-project-name="Serverpod" data-project-color="#020F24" data-project-logo="https://avatars.githubusercontent.com/u/48181558?s=200&amp;v=4" async></script><link rel="stylesheet" href="/assets/css/styles.c77738bc.css">
<script src="/assets/js/runtime~main.616faf18.js" defer="defer"></script>
<script src="/assets/js/runtime~main.067cee69.js" defer="defer"></script>
<script src="/assets/js/main.41d55010.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
2 changes: 1 addition & 1 deletion docs/0.9.10/concepts/caching.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.6.3">
<title data-rh="true">Caching | Serverpod</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://serverpod.github.io/0.9.10/concepts/caching"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="0.9.10"><meta data-rh="true" name="docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" name="docsearch:version" content="0.9.10"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" property="og:title" content="Caching | Serverpod"><meta data-rh="true" name="description" content="Accessing the database can sometimes be expensive for complex database queries or if you need to run many different queries for a specific task. Serverpod makes it easy to cache frequently requested objects in RAM. Any serializable object can be cached. If your Serverpod is hosted across multiple servers in a cluster, objects are stored in the Redis cache."><meta data-rh="true" property="og:description" content="Accessing the database can sometimes be expensive for complex database queries or if you need to run many different queries for a specific task. Serverpod makes it easy to cache frequently requested objects in RAM. Any serializable object can be cached. If your Serverpod is hosted across multiple servers in a cluster, objects are stored in the Redis cache."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://serverpod.github.io/0.9.10/concepts/caching"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/concepts/caching" hreflang="en"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/concepts/caching" hreflang="x-default"><script src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9ae02024-c2cf-4f58-b2d9-7ca3961dc1ef" data-project-name="Serverpod" data-project-color="#020F24" data-project-logo="https://avatars.githubusercontent.com/u/48181558?s=200&amp;v=4" async></script><link rel="stylesheet" href="/assets/css/styles.c77738bc.css">
<script src="/assets/js/runtime~main.616faf18.js" defer="defer"></script>
<script src="/assets/js/runtime~main.067cee69.js" defer="defer"></script>
<script src="/assets/js/main.41d55010.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
4 changes: 2 additions & 2 deletions docs/0.9.10/concepts/database-communication.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.6.3">
<title data-rh="true">Database communication | Serverpod</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://serverpod.github.io/0.9.10/concepts/database-communication"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="0.9.10"><meta data-rh="true" name="docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" name="docsearch:version" content="0.9.10"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-0.9.10"><meta data-rh="true" property="og:title" content="Database communication | Serverpod"><meta data-rh="true" name="description" content="Serverpod makes it easy to communicate with your database using strictly typed objects without a single SQL line. But, if you need to do more complex tasks, you can always do direct SQL calls. You define your database mappings right in the protocol yaml files."><meta data-rh="true" property="og:description" content="Serverpod makes it easy to communicate with your database using strictly typed objects without a single SQL line. But, if you need to do more complex tasks, you can always do direct SQL calls. You define your database mappings right in the protocol yaml files."><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://serverpod.github.io/0.9.10/concepts/database-communication"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/concepts/database-communication" hreflang="en"><link data-rh="true" rel="alternate" href="https://serverpod.github.io/0.9.10/concepts/database-communication" hreflang="x-default"><script src="https://widget.kapa.ai/kapa-widget.bundle.js" data-website-id="9ae02024-c2cf-4f58-b2d9-7ca3961dc1ef" data-project-name="Serverpod" data-project-color="#020F24" data-project-logo="https://avatars.githubusercontent.com/u/48181558?s=200&amp;v=4" async></script><link rel="stylesheet" href="/assets/css/styles.c77738bc.css">
<script src="/assets/js/runtime~main.616faf18.js" defer="defer"></script>
<script src="/assets/js/runtime~main.067cee69.js" defer="defer"></script>
<script src="/assets/js/main.41d55010.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand All @@ -18,7 +18,7 @@ <h2 class="anchor anchorWithStickyNavbar_LWe7" id="database-mappings">Database m
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#00a4db">class</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> UserData</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">fields</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">name</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> String</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">password</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> String</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> database</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p>Likewise, if you only want a field to be accessible in the protocol but not stored in the server, you can add the <code>api</code> flag. By default, a field is accessible to both the API and the database.</p>
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="database-indexes">Database indexes<a href="#database-indexes" class="hash-link" aria-label="Direct link to Database indexes" title="Direct link to Database indexes">​</a></h3>
<p>For performance reasons, you may want to add indexes to your database tables. You add these in the yaml-files defining the serializable objects.</p>
<p>For performance reasons, you may want to add indexes to your database tables. You add these in the YAML-files defining the serializable objects.</p>
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token key atrule" style="color:#00a4db">class</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> Company</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">table</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> company</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">fields</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">name</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> String</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">foundedDate</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> DateTime</span><span class="token punctuation" style="color:#393A34">?</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">employees</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> List&lt;Employee</span><span class="token punctuation" style="color:#393A34">&gt;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token key atrule" style="color:#00a4db">indexes</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">company_name_idx</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token key atrule" style="color:#00a4db">fields</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> name</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p>The <code>fields</code> key holds a comma-separated list of column names. In addition, it&#x27;s possible to add a type key (default is <code>btree</code>), and a <code>unique</code> key (default is <code>false</code>).</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="making-queries">Making queries<a href="#making-queries" class="hash-link" aria-label="Direct link to Making queries" title="Direct link to Making queries">​</a></h2>
Expand Down
Loading

0 comments on commit 8f51d2e

Please sign in to comment.