Struct Note 

pub struct Note { /* private fields */ }

A note from Bear’s database.

Nullable Fields

Only one field in Bear notes can be NULL in the database:

• content: Empty notes may have None for content.

Always-Present Fields

The following fields are always present (never NULL):

• title: All notes have titles (may be empty string, but never NULL)
• unique_id: Bear’s UUID identifier (always present)
• id: Primary key (always present)
• modified, created: Timestamps (always present)
• is_pinned: Boolean flag (always present)

Identifiers

Bear notes use UUIDs as their primary identifier:

UUID (id())

• Type: &NoteId (Bear’s UUID like ‘ABC123-DEF456-…’)
• Always present (never NULL)
• Stable across the lifetime of the note and across devices
• Use this for all programmatic references and API calls
• Bear uses this for syncing and x-callback-url schemes
• Used in Bear’s x-callback-url API (e.g., bear://x-callback-url/open-note?id=UUID)

The internal Core Data primary key is not exposed in the public API.

Example

let db = BearDb::new()?;
let notes = db.notes(NotesQuery::default())?;

for note in notes {
    let note_id = note.id();
    let title = note.title();

    // Only content may be None
    let content = note.content().unwrap_or("");

    println!("Note {}: {} ({} bytes)", note_id.as_str(), title, content.len());
}

Implementations

impl Note

pub fn id(&self) -> &NoteId

Returns the note’s Bear identifier.

This is Bear’s UUID identifier, which is:

• Always present (never NULL)
• Stable across the note’s lifetime
• Works across devices (syncing)
• Used in Bear’s x-callback-url API

Use this for:

• Opening notes in Bear
• Storing references to notes
• Matching notes across devices

Example

let note_id = note.id();
println!("Open in Bear: bear://x-callback-url/open-note?id={}", note_id.as_str());

Examples found in repository

examples/query_demo.rs (line 17)

fn main() -> Result<(), BearError> {
  let db = BearDb::new()?;

  // Example 1: Using typed API
  println!("=== Typed API Examples ===\n");

  let tags = db.tags()?;
  println!("Total tags: {}\n", tags.count());

  // Using the new NotesQuery API - much more readable!
  db.notes(NotesQuery::default())?
    .into_iter()
    .for_each(|note| {
      println!("Note: {:?}", note.title());
      db.note_links(note.id())
        .unwrap()
        .into_iter()
        .for_each(|link| println!("  Linked: {:?}", link.title()));

      let note_tags = db.note_tags(note.id()).unwrap();
      println!("  Tags: {:?}\n", tags.names(&note_tags));
    });

  // Example 2: Using generic SQL query API with DataFrames
  println!("\n=== Generic SQL Query API Examples ===\n");

  // Simple query
  println!("Top 5 most recent notes:");
  let df = db
    .query("SELECT title, created FROM notes WHERE is_trashed = 0 ORDER BY created DESC LIMIT 5")?;
  println!("{}\n", df);

  // Join query
  println!("Notes with their tags:");
  let df = db.query(
    r"
    SELECT n.title, t.name as tag_name
    FROM notes n
    JOIN note_tags nt ON n.id = nt.note_id
    JOIN tags t ON nt.tag_id = t.id
    WHERE n.is_trashed = 0
    ORDER BY n.modified DESC
    LIMIT 10
  ",
  )?;
  println!("{}\n", df);

  // Aggregation query
  println!("Tag usage statistics:");
  let df = db.query(
    r"
    SELECT t.name, COUNT(*) as note_count
    FROM tags t
    JOIN note_tags nt ON t.id = nt.tag_id
    GROUP BY t.id, t.name
    ORDER BY note_count DESC
    LIMIT 10
  ",
  )?;
  println!("{}\n", df);

  Ok(())
}

pub fn title(&self) -> &str

Returns the note’s title.

All notes have titles (this is never NULL), though the title may be an empty string.

Example

let title = note.title();
if title.is_empty() {
    println!("[Untitled]");
} else {
    println!("Title: {}", title);
}

Examples found in repository

examples/query_demo.rs (line 16)

fn main() -> Result<(), BearError> {
  let db = BearDb::new()?;

  // Example 1: Using typed API
  println!("=== Typed API Examples ===\n");

  let tags = db.tags()?;
  println!("Total tags: {}\n", tags.count());

  // Using the new NotesQuery API - much more readable!
  db.notes(NotesQuery::default())?
    .into_iter()
    .for_each(|note| {
      println!("Note: {:?}", note.title());
      db.note_links(note.id())
        .unwrap()
        .into_iter()
        .for_each(|link| println!("  Linked: {:?}", link.title()));

      let note_tags = db.note_tags(note.id()).unwrap();
      println!("  Tags: {:?}\n", tags.names(&note_tags));
    });

  // Example 2: Using generic SQL query API with DataFrames
  println!("\n=== Generic SQL Query API Examples ===\n");

  // Simple query
  println!("Top 5 most recent notes:");
  let df = db
    .query("SELECT title, created FROM notes WHERE is_trashed = 0 ORDER BY created DESC LIMIT 5")?;
  println!("{}\n", df);

  // Join query
  println!("Notes with their tags:");
  let df = db.query(
    r"
    SELECT n.title, t.name as tag_name
    FROM notes n
    JOIN note_tags nt ON n.id = nt.note_id
    JOIN tags t ON nt.tag_id = t.id
    WHERE n.is_trashed = 0
    ORDER BY n.modified DESC
    LIMIT 10
  ",
  )?;
  println!("{}\n", df);

  // Aggregation query
  println!("Tag usage statistics:");
  let df = db.query(
    r"
    SELECT t.name, COUNT(*) as note_count
    FROM tags t
    JOIN note_tags nt ON t.id = nt.tag_id
    GROUP BY t.id, t.name
    ORDER BY note_count DESC
    LIMIT 10
  ",
  )?;
  println!("{}\n", df);

  Ok(())
}

pub fn content(&self) -> Option<&str>

Returns the note’s content (Markdown), if present.

Returns None for empty notes or notes with NULL content.

Example

let content = note.content().unwrap_or("");
println!("Content length: {} bytes", content.len());

pub fn modified(&self) -> OffsetDateTime

Returns the timestamp of the note’s last modification.

This is always present (never NULL).

pub fn created(&self) -> OffsetDateTime

Returns the timestamp when the note was created.

This is always present (never NULL).

pub fn is_pinned(&self) -> bool

Returns whether the note is pinned.

This is always present (never NULL).

Trait Implementations

impl Debug for Note

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.