Add layer to sdk docs

no10ds · Sep 12, 2023 · 1babc18 · 1babc18
1 parent dc9d6f2
commit 1babc18
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/sdk/usage.md b/docs/sdk/usage.md
@@ -46,7 +46,7 @@ raw_data = [{"a": 1, "b": 2, "c": 3}, {"a": 10, "b": 20, "c": 30}]
 df = pd.DataFrame(raw_data)
 
 schema = rapid.generate_schema(
-    df=df, domain="domain", dataset="dataset", sensitivity="PUBLIC"
+    df=df, layer="layer", domain="domain", dataset="dataset", sensitivity="PUBLIC"
 )
 
 print("Domain ", schema.metadata.domain)
@@ -61,7 +61,9 @@ The sdk provides an easy way to automatically download a specific dataset based
 import pandas as pd
 from rapid import Rapid
 
-data = rapid.download_dataframe(domain="domain", dataset="dataset", version=1)
+data = rapid.download_dataframe(
+    layer="layer", domain="domain", dataset="dataset", version=1
+)
 
 print(data.info())
 ```
@@ -78,7 +80,7 @@ query = Query(
 )
 
 data = rapid.download_dataframe(
-    domain="domain", dataset="dataset", version=1, query=query
+    layer="layer", domain="domain", dataset="dataset", version=1, query=query
 )
 
 print(data.info())

diff --git a/docs/sdk/useful_patterns.md b/docs/sdk/useful_patterns.md
@@ -17,6 +17,7 @@ raw_data = [{"a": 1, "b": 2, "c": 3}, {"a": 10, "b": 20, "c": 30}]
 df = pd.DataFrame(raw_data)
 
 metadata = SchemaMetadata(
+    layer="default",
     domain="mydomain",
     dataset="mydataset",
     owners=[Owner(name="myname", email="myemail@email.com")],
@@ -48,6 +49,7 @@ raw_data = [{"a": 1, "b": 2, "c": 3}, {"a": 10, "b": 20, "c": 30}]
 df = pd.DataFrame(raw_data)
 
 metadata = SchemaMetadata(
+    layer="default",
     domain="mydomain",
     dataset="mydataset",
     owners=[Owner(name="myname", email="myemail@email.com")],